First of all, thank you for considering contributing to this project! Whether you're fixing a bug, adding a feature, or improving documentation, your help is greatly appreciated.
Start by forking the repository. This allows you to make changes without affecting the main project directly.
Create a new branch for your feature or fix. We recommend naming branches clearly, such as:
feature/awesome-new-featurebugfix/{issue number}-fix-crash-on-startup
Make the necessary changes in your branch. Follow the code style and formatting used in the project. If you are adding new functionality, remember to also update or create tests as needed.
If your change introduces new functionality or modifies existing functionality, please write tests to cover those changes. All tests should pass before submitting your pull request.
Important
Olingo has its own repository for documentation!. This repo can be found here: https://github.com/Olingo-dev/docs
Ensure that any new functionality or changes are reflected in the documentation. This documentation can be found at https://github.com/Olingo-dev/docs
Once your changes are ready, submit a pull request (PR) to the canary branch of the repository. In your PR description:
- Clearly explain what you’ve done and why
- Link to any relevant issue numbers (e.g.,
Fixes #123) - Provide any additional context that may be helpful for reviewers
Once you submit your pull request, the maintainers will review it. You may be asked to make changes or improvements. Please be responsive to feedback.
After approval, your PR will be merged into the main branch. Congratulations, you've contributed to the project!
By participating in this project, you agree to adhere to the Code of Conduct.
- Issue Tracker: If you encounter bugs or have feature requests, please use the issue tracker to report them.
- Discussion: For general discussions, you can join our community.