|
1 |
| -# Issue Labeling |
| 1 | +## How can I help? |
| 2 | + |
| 3 | +Everyone is encouraged to open issues that are affecting you: bugs, ideas, performance problems – everything helps! |
| 4 | + |
| 5 | +The first place to start is by looking at our [GitHub Issues](https://github.com/rails-api/active_model_serializers/issues). |
| 6 | + |
| 7 | +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. |
| 8 | + |
| 9 | +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). |
| 10 | + |
| 11 | +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. |
| 12 | + |
| 13 | +If you want to work on new feature development, look for the label [**Feature**](https://github.com/rails-api/active_model_serializers/labels/Feature). |
| 14 | + |
| 15 | +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. |
| 16 | + |
| 17 | +## Issue Labeling |
2 | 18 |
|
3 | 19 | 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).
|
4 | 20 |
|
5 | 21 | ## Contributing
|
6 | 22 |
|
7 | 23 | 1. Fork it ( https://github.com/rails-api/active_model_serializers/fork )
|
8 | 24 | 2. Create your feature branch (`git checkout -b my-new-feature`)
|
9 |
| -3. Commit your changes (`git commit -am 'Add some feature'`) |
10 |
| -4. Push to the branch (`git push origin my-new-feature`) |
11 |
| -5. Create a new Pull Request |
| 25 | +3. Write tests for your feature, or regression tests highlighting a bug |
| 26 | +4. Write the feature itself, or fix your bug |
| 27 | +5. Commit your changes (`git commit -am 'Add some feature'`) |
| 28 | +6. Push to the branch (`git push origin my-new-feature`) |
| 29 | +7. Create a new Pull Request |
| 30 | + |
| 31 | +Remember to squash your commits and rebase off `master`. |
0 commit comments