Contributions are welcome, and they are greatly appreciated! When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
Please note we have a code of conduct, please follow it in all your interactions with the project.
Report bugs at https://github.com/deephdc/DEEP-OC-generic-dev/issues
If you are reporting a bug, please include:
- Your operating system name and version.
- Any details about your local setup that might be helpful in troubleshooting.
- If you can, provide detailed steps to reproduce the bug.
- If you don't have steps to reproduce the bug, just note your observations in as much detail as you can. Questions to start a discussion about the issue are welcome.
The best way to send feedback is to file an issue at the follwing URL:
https://github.com/deephdc/DEEP-OC-generic-dev/issues
If you are proposing a feature:
- Explain in detail how it would work.
- Keep the scope as narrow as possible, to make it easier to implement.
- Remember that this is a volunteer-driven project, and that contributions are welcome :)
You are welcome to open Pull Requests for either fixing a bug, adding a new feature, contributing to the documentation, etc.
- Fork the repository and create a new branch from
master. - If you’ve fixed a bug or added code that should be tested, add tests!
- Make sure your code lints (e.g. flake8 for python to comply with PEP8).
- Update the README.md with details of changes, e.g. new environment variables, exposed ports, container parameters etc.
- Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is SemVer.
- Push the changes to your fork.
- Create a Pull Request to this repository.
- Review and address comments on your pull request.