Skip to content

Commit

Permalink
Merge pull request #842 from rails-api/add-contribution-process
Browse files Browse the repository at this point in the history
Add notes on how you can help to contributing documentation
  • Loading branch information
joshsmith committed Mar 16, 2015
2 parents 0446a97 + 65cf7d4 commit 9058d5f
Showing 1 changed file with 24 additions and 4 deletions.
28 changes: 24 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,31 @@
# Issue Labeling
## How can I help?

Everyone is encouraged to open issues that are affecting you: bugs, ideas, performance problems – everything helps!

The first place to start is by looking at our [GitHub Issues](https://github.com/rails-api/active_model_serializers/issues).

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.

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).

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.

If you want to work on new feature development, look for the label [**Feature**](https://github.com/rails-api/active_model_serializers/labels/Feature).

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.

## Issue Labeling

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).

## Contributing

1. Fork it ( https://github.com/rails-api/active_model_serializers/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request
3. Write tests for your feature, or regression tests highlighting a bug
4. Write the feature itself, or fix your bug
5. Commit your changes (`git commit -am 'Add some feature'`)
6. Push to the branch (`git push origin my-new-feature`)
7. Create a new Pull Request

Remember to squash your commits and rebase off `master`.

0 comments on commit 9058d5f

Please sign in to comment.