diff options
| -rw-r--r-- | CONTRIBUTING.md | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..96d2854c9 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,41 @@ +CONTRIBUTING +============ + +There are three ways in which you can contribute to this repository: + +1. By improving the documentation +2. By working on the back-end application +3. By working on the front-end application + +Below are the guidelines for working on pull requests: + +## General + +- 2 spaces indendation + +## Documentation + +- No spelling mistakes +- No orthographic mistakes +- No Markdown syntax errors + +## Back-end application + +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. + +* The codebase is not perfect, at the time of writing, but it is expected that you do not introduce new code style violations +* The rspec test suite must pass +* 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 +* If you are introducing new strings to the user interface, they must be using localization methods + +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. + +## Front-end application + +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. + +* Avoid grave ESLint violations +* Verify that your changes work +* If you are introducing new strings, they must be using localization methods + +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. |