Guides > STYLE

STYLE

Code & 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.

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.