Nice having you onboard!
We love contributions from everyone and here are a few things to keep in mind when contributing.
Somethings not working like it should? We've got you covered!
- Use Github to create an issue;
- Write a descriptive title;
- Fill out the issue template;
- Wait for a developer to make coffee and get back to you;
You want to help out by contributing code? Here's a checklist for a pull request:
- Fork the project;
- Create a branch for your code;
- Write your awesome code;
- Adhere to the coding style
- For Python we use the OpenStack Style Guidelines
- For JavaScript we use the Airbnb JavaScript Style Guide as the basis, but with some small changes. All rules can be found in the .eslintrc file. Note: While most of the app is still in ES5, we're trying to write new code in ES6.
- For (S)CSS we mostly use the default SCSS-Lint configuration. All rules can be found the .scss-lint.yml file.
- Make sure all tests pass (
docker-compose run web python manage.py test); - Don't forget to add yourself to the CONTRIBUTORS.md file;
- Squash commits and provide a sane commit message;
- Create a pull request;
- Write a descriptive title;
- Fill out the pull request template;
- Wait for a developer to make coffee and get back to you;