2018-02-23 04:03:14 +00:00
# Contributing to Onionr
2018-12-09 17:29:39 +00:00
2019-06-12 00:05:15 +00:00
One of the great things about open source projects is that they allow for anyone to contribute to the project.
2018-12-09 17:29:39 +00:00
This file serves to provide guidelines on how to successfully contribute to Onionr.
2018-02-23 04:03:14 +00:00
## Code of Conduct
2018-03-03 09:03:42 +00:00
2019-05-18 18:46:48 +00:00
Contributors in project-related spaces/contexts are expected to follow the [Code of Conduct ](https://github.com/beardog108/onionr/blob/master/CODE_OF_CONDUCT.md )
2018-02-23 04:03:14 +00:00
## Reporting Bugs
2018-12-09 17:29:39 +00:00
Bugs can be reported using GitLab issues. Please try to see if an issue is already opened for a particular thing.
Please provide the following information when reporting a bug:
2018-02-23 04:03:14 +00:00
2018-12-09 17:29:39 +00:00
* Operating system
* Python version
* Onionr version
* Onionr logs or output with errors, any possible relevant information.
* A description of what you were doing before the bug was experienced
* Screenshots can often be helpful, but videos are rarely helpful.
If a bug is a security issue, please contact us privately.
2019-05-18 18:46:48 +00:00
And most importantly, please be patient. Onionr is a free open source project maintained by volunteers in their free time.
2018-02-23 04:03:14 +00:00
## Asking Questions
2019-05-18 18:46:48 +00:00
If you need help with Onionr, you can contact the devs (be polite and remember this is a volunteer-driven project).
Do your best to use good english.
2018-02-23 04:03:14 +00:00
## Contributing Code
2018-12-09 17:29:39 +00:00
For any non-trivial changes, please get in touch with us first to discuss your plans.
Please try to use a similar coding style as the project.
2018-02-23 04:03:14 +00:00
**Thanks for contributing to Onionr!**
