Skip to content

Commit 89ebba2

Browse files
committed
Add notes on how you can help to contributing documentation
1 parent 0446a97 commit 89ebba2

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

CONTRIBUTING.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,18 @@
1-
# Issue Labeling
1+
## How can I help?
2+
3+
The first place to start is by looking at our [GitHub Issues](https://github.com/rails-api/active_model_serializers/issues).
4+
5+
The vast majority of development is happening under the `master` branch, currently slated for release as `0.10.x`. This is where we would suggest you start.
6+
7+
Fixing bugs is extraordinarily helpful and requires the least familiarity with AMS. Look for issues labeled [**Needs Bug Verification**](https://github.com/rails-api/active_model_serializers/labels/Needs%20Bug%20Verification) and [**Bug**](https://github.com/rails-api/active_model_serializers/labels/bug).
8+
9+
We are also actively working to identify tasks under the label [**Good for New Contributors**](https://github.com/rails-api/active_model_serializers/labels/Good%20for%20New%20Contributors). Some bugs are expressly not good for new contributors, so don't expect 100% overlap between the two.
10+
11+
If you want to work on new feature development, look for the label [**Feature**](https://github.com/rails-api/active_model_serializers/labels/Feature).
12+
13+
We are also encouraging comments to substantial changes (larger than bugfixes and simple features) under an "RFC" (Request for Comments) process before we start active development. Look for the [**RFC**](https://github.com/rails-api/active_model_serializers/labels/RFC) label.
14+
15+
## Issue Labeling
216

317
AMS 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).
418

@@ -8,4 +22,4 @@ AMS uses a subset of [StandardIssueLabels](https://github.com/wagenet/StandardIs
822
2. Create your feature branch (`git checkout -b my-new-feature`)
923
3. Commit your changes (`git commit -am 'Add some feature'`)
1024
4. Push to the branch (`git push origin my-new-feature`)
11-
5. Create a new Pull Request
25+
5. Create a new Pull Request

0 commit comments

Comments
 (0)