First off, thank you for thinking of contributing to this project! 🥳
The following is a set of guidelines for contributing to Ona Data. Following these guidelines helps to communicate that you respect the time of the maintainers and your intent to help develop this project.
In case you have encountered any issue within the project, please make sure:
- You are using the latest release.
- You have setup the project according to the Installation Documentation.
After confirming the above, make sure the issue has not been reported on our issues page. If it hasn't been reported, open a ticket containing:
- Information about your system environment (Operating System, local settings, etc.).
- What you expected to happen, and what actually happened.
- Out of place / weird logs and any other interesting information
- All steps to reproduce the issue.
Feature and enhancement requests are always welcome! We ask you ensure the following details are provided while opening a ticket, in order to start a constructive discussion:
- Describe the feature/enhancement in detail.
- Explain why the feature/enhancement is needed.
- Describe how the feature/enhancement should work
- List any advantages & disadvantages of implementing the feature/enhancement
Pull requests are wholeheartedly welcome!❤️ If you are unsure about how to make your first pull request, here are some helpful resources:
In order to make it easier for us to facilitate the smooth merging of your pull request, please make sure the following standards are met within your pull request.
- Ensure your git commits are signed. Read about signing commits here
- Code & commits follow our styleguides.
- Implement / Update tests that need to be updated and ensure that they pass. Running all the tests within this project may be tough and time consuming. But not to worry! On submission of the pull request, Travis CI will run all the tests across our modules.
With the above points in mind feel free to comment on one of our beginner-friendly issues expressing your intent to work on it.
Git commits help communicate what has changed within the project. Making it easier to track down changes or implementation within the codebase. Before contributing please read the following article by Chris Beams on How to Write a Git Commit Message.
All python code should follow the PEP 8 Style guide.
Our codebase utilizes flake8, run the following command to make sure your code fits our styling standards.
flake8 onadata --exclude=migrations,src,db_migrations,local_settings.py