CONTRIBUTING.md

   1 CONTRIBUTING
   2 ============
   3
   4 There are three ways in which you can contribute to this repository:
   5
   6 1. By improving the documentation
   7 2. By working on the back-end application
   8 3. By working on the front-end application
   9
  10 Choosing what to work on in a large open source project is not easy. The list of GitHub issues may provide some ideas, but not every feature request has been greenlit. Likewise, not every change or feature that resolves a personal itch will be merged into the main repository. Some communication ahead of time may be wise.
  11
  12 Below are the guidelines for working on pull requests:
  13
  14 ## General
  15
  16 - 2 spaces indendation
  17
  18 ## Documentation
  19
  20 - No spelling mistakes
  21 - No orthographic mistakes
  22 - No Markdown syntax errors
  23
  24 ## Back-end application
  25
  26 It is expected that you have a working development environment set up. The development environment includes rubocop, which checks your Ruby code for compliance with our style guide and best practices. Sublime Text, likely like other editors, has a Rubocop plugin that runs checks on files as you edit them. The codebase also has a test suite.
  27
  28 * The codebase is not perfect, at the time of writing, but it is expected that you do not introduce new code style violations
  29 * The rspec test suite must pass
  30 * To the extent that it is possible, verify your changes. In the best case, by adding new tests to the test suite. At the very least, by running the server or console and checking it manually
  31 * If you are introducing new strings to the user interface, they must be using localization methods
  32
  33 If your code has syntax errors that won't let it run, it's a good sign that the pull request isn't ready for submission yet.
  34
  35 ## Front-end application
  36
  37 It is expected that you have a working development environment set up (see back-end application section). This project includes an ESLint configuration file, with which you can lint your changes.
  38
  39 * Avoid grave ESLint violations
  40 * Verify that your changes work
  41 * If you are introducing new strings, they must be using localization methods
  42
  43 If the JavaScript or CSS assets won't compile due to a syntax error, it's a good sign that the pull request isn't ready for submission yet.