diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..af3ac72 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,44 @@ +# Contributing guidelines + +## Pull Request Checklist + +Before sending your pull requests, make sure you followed this list. + +- Read [contributing guidelines](CONTRIBUTING.md). +- Read [Code of Conduct](CODE_OF_CONDUCT.md). +- Check if my changes are consistent with the [guidelines](https://github.com/RentadroneCL/model-definition/blob/master/CONTRIBUTING.md#general-guidelines-and-philosophy-for-contribution). +- Changes are consistent with the [Coding Style](https://github.com/RentadroneCL/model-definition/blob/master/CONTRIBUTING.md#c-coding-style). +- Run [Unit Tests](https://github.com/RentadroneCL/model-definition/CONTRIBUTING.md#running-unit-tests). + +## How to become a contributor and submit your own code + +### Contributor License Agreements + +We'd love to accept your patches! + +### Contributing code + +If you have improvements to this project, send us your pull requests! For those +just getting started, Github has a +[how to](https://help.github.com/articles/using-pull-requests/). + +Rentadrone.cl team members will be assigned to review your pull requests. Once the +pull requests are approved and pass continuous integration checks, a Rentadrone.cl +team member will apply `ready to pull` label to your change. This means we are +working on getting your pull request submitted to our internal repository. After +the change has been submitted internally, your pull request will be merged +automatically on GitHub. + +If you want to contribute, start working through the project codebase, +navigate to the +[Github "issues" tab](https://github.com/RentadroneCL/model-definition/issues) and start +looking through interesting issues. + +These are issues that we believe are particularly well suited for outside +contributions, often because we probably won't get to them right now. If you +decide to start on an issue, leave a comment so that other people know that +you're working on it. If you want to help out, but not alone, use the issue +comment thread to coordinate. + +make sure your changes are consistent with the guidelines and follow the +[PEP 8 -- Style Guide for Python Code](https://www.python.org/dev/peps/pep-0008/) coding style.