Contributing

See also Contributing for non-code contributions.

  • Make a new branch off of the development branch (see Fork)
  • It helps if the branch tracks an issue number, like 1234_my_feature_request
  • Add tests
  • If you have experience, rebase your branch against development before making a pull request
  • Make a pull request
    • From your repository on Github select your branch, and use buttons there to make a pull request.

Conventions

  • Various README.md and ARCHITECTURE.md files exist in the code-base
  • We have a code linter (Rubocop), but it is not heavily used
  • Code documentation is done inline with Yard tags.