Contributing to pgcli-rails

June 27, 2019 ยท View on GitHub

Have a feature idea, bug fix, or refactoring suggestion? Contributions are welcome!

Pull requests

  1. Check Issues to see if your contribution has already been discussed and/or implemented.
  2. If not, open an issue to discuss your contribution. I won't accept all changes and do not want to waste your time.
  3. Once you have the :thumbsup:, fork the repo, make your changes, and open a PR.

Coding guidelines

  • This project has a coding style enforced by RuboCop. Use hash rockets and double-quoted strings, and otherwise try to follow the Ruby style guide.
  • Writing tests is strongly encouraged! This project uses Minitest.

Getting started

After checking out the repo, run bin/setup to install dependencies.

Use rake to execute all of pgcli-rails's tests and RuboCop checks