First of all, thank you for contributing to eo-learn-examples. Any effort in contributing to the collection of examples is very much appreciated.
Here is how you can contribute:
All contributors agree to follow our Code of Conduct.
eo-learn-examples repository is distributed under the MIT license. When contributing, you agree to its terms and conditions. If you would like to keep parts of your contribution private, you can contact us to discuss about the best solution.
For any question, feel free to contact us at [email protected] or through our Forum.
We strive to provide high-quality working code, but bugs happen nevertheless.
When reporting a bug, please check here whether the bug was already reported. If not, open an issue with the bug label and report the following information:
- Issue description
- Example that is affected
- How to reproduce the issue
- Expected outcome
- Actual outcome
- OS and package versions
This information helps us to reproduce, pinpoint, and fix the reported issue.
If you are not sure whether the odd behaviour is a bug or a feature, best to open an issue and clarify.
Existing feature requests can be found here.
A new feature request can be created by opening a new issue with the enhancement label, and describing how the feature would benefit the eo-learn and eo-learn-examples community.
The GitHub Pull Request (PR) mechanism is the best option to contribute code to the library. Users can fork the repository, make their contribution to their local fork and create a PR to add those changes to the codebase. GitHub provides excellent tutorials on how the fork and pull mechanism work, and on how to best create a PR.
Existing PRs can be found here. Before creating new PRs, you should check whether someone else has contributed a similar feature, and if so, you can add your input to the existing code review.
The following guidelines should be observed when creating a PR.