From 89ebba239c7811a64bcf379584557cda92b22855 Mon Sep 17 00:00:00 2001 From: Josh Smith Date: Sun, 15 Mar 2015 19:44:34 -0700 Subject: [PATCH 1/2] Add notes on how you can help to contributing documentation --- CONTRIBUTING.md | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 853c97e1..cbc867a5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,18 @@ -# Issue Labeling +## How can I help? + +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). @@ -8,4 +22,4 @@ AMS uses a subset of [StandardIssueLabels](https://github.com/wagenet/StandardIs 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 \ No newline at end of file +5. Create a new Pull Request From 65cf7d41c9b0651f1b16a0e7c0ea1bcd71240026 Mon Sep 17 00:00:00 2001 From: Josh Smith Date: Sun, 15 Mar 2015 20:26:33 -0700 Subject: [PATCH 2/2] =?UTF-8?q?Add=20suggestions=20from=20Jo=C3=A3o?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CONTRIBUTING.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cbc867a5..d18965d1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,7 @@ ## 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. @@ -20,6 +22,10 @@ AMS uses a subset of [StandardIssueLabels](https://github.com/wagenet/StandardIs 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`.