Skip to content

Commit c3c72d5

Browse files
committed
[DOCS] Refactor, update, create documentation [ci skip]
1 parent f562449 commit c3c72d5

24 files changed

+693
-462
lines changed

CHANGELOG.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@ Breaking changes:
55
- [#1131](https://github.com/rails-api/active_model_serializers/pull/1131) Remove Serializer#root_name (@beauby)
66
- [#1138](https://github.com/rails-api/active_model_serializers/pull/1138) Introduce Adapter::Base (@bf4)
77
* Adapters now inherit Adapter::Base. 'Adapter' is now a module, no longer a class.
8-
* using a class as a namespace that you also inherit from is complicated and circular at time i.e.
8+
* using a class as a namespace that you also inherit from is complicated and circular at times i.e.
99
buggy (see https://github.com/rails-api/active_model_serializers/pull/1177)
1010
* The class methods on Adapter aren't necessarily related to the instance methods, they're more
11-
Adapter functions
12-
* named `Base` because it's a Rails-ism
13-
* It helps to isolate and highlight what the Adapter interface actually is
11+
Adapter functions.
12+
* named `Base` because it's a Rails-ism.
13+
* It helps to isolate and highlight what the Adapter interface actually is.
1414

1515
Features:
1616

@@ -42,6 +42,8 @@ Misc:
4242
- [#1166](https://github.com/rails-api/active_model_serializers/pull/1166) Prefer methods over instance variables (@bf4)
4343
- [#1168](https://github.com/rails-api/active_model_serializers/pull/1168) Fix appveyor failure cache not being expired (@bf4)
4444
- [#1161](https://github.com/rails-api/active_model_serializers/pull/1161) Remove duplicate test helper (@bf4)
45+
- [#1371](https://github.com/rails-api/active_model_serializers/pull/1371) Refactor, update, create documentation (@bf4)
46+
4547

4648
### v0.10.0.rc3 (2015/09/16 15:19 +00:00)
4749
- [#1129](https://github.com/rails-api/active_model_serializers/pull/1129) Remove SerializableResource.serialize in favor of `.new` (@bf4)

CONTRIBUTING.md

Lines changed: 23 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ http://www.commitstrip.com/en/2014/05/07/the-truth-behind-open-source-apps/](doc
88

99
## How can I help?
1010

11+
- [Filing an issue](CONTRIBUTING.md#filing-an-issue)
12+
- [Writing code and comments](CONTRIBUTING#writing-code-and-comments)
13+
1114
### Filing an issue
1215

1316
Everyone is encouraged to open issues that are affecting them:
@@ -20,7 +23,6 @@ bugs, ideas, documentation (`/docs`), performance problems – everything helps!
2023
- Check if your issue has already been reported.
2124
- If you find an existing issue report, feel free to add further information to that report.
2225

23-
2426
#### Writing
2527

2628
If possible, please include the following information when [reporting an
@@ -82,22 +84,27 @@ And please don't forget to stay involved in the issue until it is closed! Thanks
8284

8385
- We are actively working to identify tasks under the label [**Good for New
8486
Contributors**](https://github.com/rails-api/active_model_serializers/labels/Good%20for%20New%20Contributors).
85-
Some bugs are expressly not good for new contributors, so don't expect 100% overlap between the two.
8687
- [Changelog
8788
Missing](https://github.com/rails-api/active_model_serializers/issues?q=label%3A%22Changelog+Missing%22+is%3Aclosed) is
8889
an easy way to help out.
8990

90-
- If you want to work on new feature development, look for the label [**Feature**](https://github.com/rails-api/active_model_serializers/labels/Feature).
91+
- [Fix a bug](https://github.com/rails-api/active_model_serializers/labels/Ready%20for%20PR).
92+
- Ready for PR - A well defined bug, needs someone to PR a fix.
93+
- Bug - Anything that is broken.
94+
- Regression - A bug that did not exist in previous versions and isn't a new feature (applied in tandem with Bug).
95+
- Performance - A performance related issue. We could track this as a bug, but usually these would have slightly lower priority than standard bugs.
96+
97+
- [Develop new features](https://github.com/rails-api/active_model_serializers/labels/Feature).
98+
99+
- [Improve code quality](https://codeclimate.com/github/rails-api/active_model_serializers/code?sort=smell_count&sort_direction=desc).
100+
101+
- [Improve amount of code exercised by tests](https://codeclimate.com/github/rails-api/active_model_serializers/coverage?sort=covered_percent&sort_direction=asc).
91102

92103
- We are also encouraging comments to substantial changes (larger than bugfixes and simple features) under an
93104
"RFC" (Request for Comments) process before we start active development.
94105
Look for the [**RFC**](https://github.com/rails-api/active_model_serializers/labels/RFC) label.
95106

96-
## Issue Labeling
97-
98-
ActiveModelSerializers uses a subset of [StandardIssueLabels](https://github.com/wagenet/StandardIssueLabels) for Github Issues. You can [see our labels here](https://github.com/rails-api/active_model_serializers/labels).
99-
100-
## Submitting a pull request (PR)
107+
#### Submitting a pull request (PR)
101108

102109
1. The vast majority of development is happening under the `master` branch.
103110
This is where we would suggest you start.
@@ -147,23 +154,27 @@ Remember to [squash your commits](CONTRIBUTING.md#about-pull-requests-prs) and r
147154
- by force pushing to it
148155
- A maintainer can make any changes themselves and manually merge the code in.
149156

150-
### Commit Messages
157+
#### Commit Messages
151158

152159
- [A Note About Git Commit Messages](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
153160
- [http://stopwritingramblingcommitmessages.com/](http://stopwritingramblingcommitmessages.com/)
154161
- [ThoughtBot style guide](https://github.com/thoughtbot/guides/tree/master/style#git)
155162

156-
### About Pull Requests (PR's)
163+
#### About Pull Requests (PR's)
157164

158165
- [Using Pull Requests](https://help.github.com/articles/using-pull-requests)
159166
- [Github pull requests made easy](http://www.element84.com/github-pull-requests-made-easy.html)
160167
- [Exercism Git Workflow](http://help.exercism.io/git-workflow.html).
161168
- [Level up your Git](http://rakeroutes.com/blog/deliberate-git/)
162169
- [All Your Open Source Code Are Belong To Us](http://www.benjaminfleischer.com/2013/07/30/all-your-open-source-code-are-belong-to-us/)
163170

164-
### Running tests
171+
## Issue Labeling
172+
173+
ActiveModelSerializers uses a subset of [StandardIssueLabels](https://github.com/wagenet/StandardIssueLabels) for Github Issues. You can [see our labels here](https://github.com/rails-api/active_model_serializers/labels).
174+
175+
## Running tests
165176

166-
#### Running with Rake
177+
### Running with Rake
167178

168179
The easiest way to run the unit tests is through Rake. The default task runs
169180
the entire test suite for all classes. For more information, checkout the

0 commit comments

Comments
 (0)