Guidelines for Developers - PatrickF1/GraceTunes GitHub Wiki

Code quality

• Follow https://github.com/bbatsov/rails-style-guide
• Consult the official Rails documentation when unclear on the proper usage or the purpose of the many parts of Rails.
  • http://guides.rubyonrails.org/v7.1
• Obscure pieces of code and lengthy functions should be commented.
• Test-driven development is mandatory, though if something is really difficult to test it’s okay to skip tests (up to discretion of code-reviewers). We are using MiniTest.
  • http://guides.rubyonrails.org/testing.html#rails-meets-minitest
• Auto-correct with rubocop -A before committing

PR workflow

• Only commit to master by squash-and-merging a PR that has at least one approval on it
• Write clear, concise PR titles. Use [tags] in the front to denote which feature or part of the code base you are changing.
• The PR description should
  • describe the "why" of the change
  • elaborate on any parts of the code design that are non-obvious
  • why you chose that particular implementation if there were viable alternatives