Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
21 lines (15 loc) · 772 Bytes

CONTRIBUTING.md

File metadata and controls

21 lines (15 loc) · 772 Bytes

Contributing

Code style

Regarding code style like indentation and whitespace, follow the conventions you see used in the source already. You can look at .rubocop.yml and .qlty/qlty.toml.

Modifying the code

First, ensure that you have installed Ruby 3.1 and recent PostgreSQL.

  1. Fork and clone the repo.
  2. Run bundle install to install all dependencies.

Assuming that you don't see any red, you're ready to go.

Submitting pull requests

  1. Create a new branch, please don't work in your master branch directly.
  2. Add failing tests for the change you want to make. Run rails test to see the tests fail.
  3. Fix stuff.
  4. Run rails test to see if the tests pass. Repeat steps 2-3 until done.
  5. Push to your fork and submit a pull request.