active_model_serializers/CONTRIBUTING.md

First of all, thank you!

Common issues and resolutions

• Using grape-active_model_serializers, or any non-Rails server. See issue.

How can I help?

• Filing an issue
• Writing code and comments

Filing an issue

Everyone is encouraged to open issues that are affecting them: bugs, ideas, documentation (/docs), performance problems – everything helps!

Before

1. Start by looking at our GitHub Issues.

• Check if your issue has already been reported.
• If you find an existing issue report, feel free to add further information to that report.

Writing

If possible, please include the following information when reporting an issue:

• ActiveModelSerializers version (0.8.x, 0.9.x, 0.10.x, commit ref).
• What are you using ActiveModelSerializers with? Rails? Grape? Other? Which versions?
• Operating system type + version.
• Ruby version: ruby -e "puts RUBY_DESCRIPTION".
• Steps to reproduce the issue (i.e. "Show me how to show myself." ). What did you expect to happen? What happened? What did you try?

Simon Tatham has written an excellent on article on How to Report Bugs Effectively which is well worth reading, although it is not specific to ActiveModelSerializers.

Thanks!

After

Thanks to everyone involved!

If you get help, sharing it back in the form of a pull-request or making an issue to document what you've found is extremely helpful.

If you solve your issue, stop working on it, or realize the problem was something else, please share that in a comment to an issue and close it. That way, everyone can learn and we don't have closed issues without a clear resolution. Even if it's just a stackoverflow link :) And please don't forget to stay involved in the issue until it is closed! Thanks to all!

Writing code and comments

• We are actively working to identify tasks under the label Good for New Contributors.

  • Changelog Missing is an easy way to help out.

• Fix a bug.

  • Ready for PR - A well defined bug, needs someone to PR a fix.
  • Bug - Anything that is broken.
  • Regression - A bug that did not exist in previous versions and isn't a new feature (applied in tandem with Bug).
  • Performance - A performance related issue. We could track this as a bug, but usually these would have slightly lower priority than standard bugs.

• Develop new features.

• Improve code quality.

• Improve amount of code exercised by tests.

• Fix RuboCop (Style) TODOS.

  • Delete and offsense, run rake rubocop (or possibly rake rubocop:auto_correct), and submit a PR.

• 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 label.

Submitting a pull request (PR)

1. The vast majority of development is happening under the master branch. This is where we would suggest you start.
2. Fixing bugs is extraordinarily helpful and requires the least familiarity with ActiveModelSerializers. Look for issues labeled Needs Bug Verification and Bug.
3. Adding or fixing documentation is also fantastic!

To fetch & test the library for development, do:

1. Fork the repository ( https://github.com/rails-api/active_model_serializers/fork )
2. git clone https://github.com/{whoami}/active_model_serializers.git
3. cd active_model_serializers
4. bundle

• To test against a particular rails version-- 4.0 is usually the most buggy-- set then RAILS_VERSION environment variable as described in the .travis.yml. e.g. export RAILS_VERSION=4.0.

1. Create your PR branch (git checkout -b my-helpful-pr)
2. Write tests for your feature, or regression tests highlighting a bug. This is important so ActiveModelSerializers doesn't break it in a future version unintentionally.
3. Write the feature itself, or fix your bug
4. bundle exec rake
5. Commit your changes (git commit -am 'Add some feature')

• Use well-described, small (atomic) commits.

1. Push to the branch (git push origin my-helpful-pr)
2. Create a new Pull Request

• Include links to any relevant github issues.
• Don't change the VERSION file.
• Update /docs to include, whenever possible, a new, suitable recommendation about how to use the feature.
• Extra Credit: Confirm it runs and tests pass on the rubies specified in the travis config. A maintainer will otherwise confirm it runs on these.

1. Bonus Points Update CHANGELOG.md with a brief description of any breaking changes, fixes, features, or miscellaneous changes under the proper version section.
2. Iterate on feedback given by the community (fix syntax, modify bits of code, add tests), pushing the new commits to the PR each time

Remember to squash your commits and rebase off master.

How maintainers handle pull requests:

• If the tests pass and the pull request looks good, a maintainer will merge it.
• If the pull request needs to be changed,
  • you can change it by updating the branch you generated the pull request from
    • either by adding more commits, or
    • by force pushing to it
  • A maintainer can make any changes themselves and manually merge the code in.

Commit Messages

• A Note About Git Commit Messages
• http://stopwritingramblingcommitmessages.com/
• ThoughtBot style guide

About Pull Requests (PR's)

• Using Pull Requests
• Github pull requests made easy
• Exercism Git Workflow.
• Level up your Git
• All Your Open Source Code Are Belong To Us

Issue Labeling

ActiveModelSerializers uses a subset of StandardIssueLabels for Github Issues. You can see our labels here.

Running tests

Run tests against different Rails versions by setting the RAILS_VERSION variable and bundling gems. To test against all versions, you can do something like:

for version in 4.0 4.1 4.2 master; do
  export RAILS_VERSION="$version"
  rm -f Gemfile.lock
  bundle check || bundle --local || bundle
  bundle exec rake test
  if [ "$?" -eq 0 ]; then
    # green in ANSI
    echo -e "\033[32m **** Tests passed against Rails ${RAILS_VERSION} **** \033[0m"
  else
    # red in ANSI
    echo -e "\033[31m **** Tests failed against Rails ${RAILS_VERSION} **** \033[0m"
  fi
  unset RAILS_VERSION
done

Running with Rake

The easiest way to run the unit tests is through Rake. The default task runs the entire test suite for all classes. For more information, checkout the full array of rake tasks with "rake -T"

Rake can be found at http://docs.seattlerb.org/rake/.

To run a single test suite

$ rake test TEST=path/to/test.rb

Which can be further narrowed down to one test:

$ rake test TEST=path/to/test.rb TESTOPTS="--name=test_something"

❤️ 💖 ❤️