Thank you for considering contributing to this project! Any kind of contributionis more than welcomed.
There are many ways to contribute to our project, either by:
- Reporting a bug
- Submitting a fix
- Proposing new features
- Implementing features
- Updating/improving documentation
We are using GitHub Issues for reporting and tracking bugs. If you find a bug, please create new issue and provide bug report:
- a short summary and/or background
- detailed steps how to reproduce the issue
- provide sample code if possible
- suggestion on how to resolve the issue, if known
Thorough bug report will speed up the process of fixing the issue.
If you find any security related bugs, do not post them as a new issue, but rather send the bug report by e-mail.
Look through the GitHub issues for bugs. Anything is open to whoever wants to implement it. If you find a bug and would like to fix it yourself, please raise an issue before you start development.
To suggest new feature open an issue on GitHub.
When proposing a new feature:
- Explain in detail how it would work.
- Keep the scope as narrow as possible to make it easier to implement.
Look through the GitHub issues labeled "kind:feature" for features. Any unassigned feature request issue is open to whoever wants to implement it.
If you find areas of improvement for documentation, our you feel that some parts are not documented, feel free to improve it.
Pull requests are the best way to propose changes to the codebase. We are following the "fork-and-pull" Git workflow. In short, these are steps that need to be executed:
- Fork the repo on GitHub
- Clone the project to your own machine
- Commit changes to your own branch
- Push your work back up to your fork
- Submit a Pull request so that we can review your changes
NOTE: Be sure to merge the latest from "upstream" before making a pull request!
By contributing, you agree that your contributions will be licensed under Apache License, Version 2.0..
You can get in touch with us by e-mail: support@syntio.net