Skip to content

Contributing

Contributions are welcome! Please raise an issue in our github repository if you have any questions or suggestions.

How to contribute

  1. Open an issue in the github repository to discuss the changes you would like to make.
  2. Once the changes are agreed upon, assign the issue to yourself and tag it with the appropriate label.
  3. Fork the repository and create a new branch for your changes.
  4. Make your changes and commit them to your branch.
  5. Propose the changes by creating a pull request.
  6. Once the pull request is approved, the changes will be merged into the development branch where they will be tested and released in the next version.

Discussing changes before making them is important to ensure that they are in line with the project's goals and to avoid duplication of effort. It also ensures that changes are correclty classified as minor, major or patch.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

  1. Be respectful of others and their opinions.
  2. Be open to feedback and constructive criticism.
  3. Be patient and understanding with others.
  4. Be kind and considerate in your interactions.
  5. Be professional and courteous at all times.

If you have any concerns or questions about the code of conduct, please raise them with the project maintainers.

Like the project and want to help me continue to work on this and prioritize your issues?

License

MIT License Copyright (c) 2018 Caio Cominato Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.