Thank you for your interest in contributing to the Open Integration Engine project. Contributions are vital to the continued growth and success of the project, and we welcome all forms of participation, whether you are a developer, a documentation contributor, or a user providing feedback.
- Be respectful and professional in all interactions.
- Provide constructive feedback and suggestions.
- Engage in discussions around pull requests and issues with an open and collaborative mindset.
Individuals can contribute code, issues, or questions at any time.
Corporations are encouraged to give time by allowing their staff to contribute to OIE with code, participation in the community, or other professional time.
Entities working on larger issues or offering significant or recurring contributions of time are encouraged to contact the OIE Steering Committee. This allows us to make the most of the contributed time for mutual benefit.
If you encounter a bug, please report it using the GitHub Issues Tracker:
- Search for existing issues to check if the problem has already been reported.
- If the issue is not listed, create a new issue with the following information:
- A clear and descriptive title.
- Steps to reproduce the issue.
- The expected vs. actual behavior.
- Any relevant logs, error messages, or screenshots to help diagnose the issue.
If you would like to suggest a new feature or enhancement:
- Open a new issue in the GitHub Issues Tracker.
- Label the issue as a feature request.
- Provide a detailed description of the feature and the problem it aims to solve.
- If applicable, include examples or use cases to demonstrate the value of the feature.
OIE has modest expenses for signing certificates, hosting, build minutes, and development tools. Our primary expense is human time for developing code and managing the project. Financial contributions will be applied to making OIE better.
Small individual donations are appreciated, however your individual time is often more valuable to us than your currency.
Corporations can contribute by:
- Investing money by paying or hiring developers to contribute code
- Directly contributing to OIE by contacting the OIE Steering Committee
- Joining a sponsoring foundation. Learn which foundations are sponsoring the project by contacting the OIE Steering Committee
Before making any changes, please open an issue in the GitHub Issues Tracker. This step helps us discuss the problem or feature before work begins, ensuring alignment and reducing redundant efforts.
Start by forking the Open Integration Engine GitHub repository to your own GitHub account.
Clone your fork locally to your development environment:
git clone git@github.com:OpenIntegrationEngine/engine.gitCreate a new branch for your feature or bug fix:
git checkout -b feature/your-feature-nameOIE specifies the working versions of Java and Ant in .sdkmanrc. To take advantage of this, install SDKMAN and run sdk env install
in the project's root directory.
Implement the necessary changes, ensuring they align with the project’s coding standards and practices.
Before submitting your changes, please ensure that all tests pass and that your changes work as expected in your local environment.
Once your changes are ready, push them to your fork and create a draft pull request (PR) from your branch to the main branch of the project. Draft PRs help indicate that the work is in progress.
Mark the PR as "Ready for review" only when it is actually complete and ready for feedback. Include a brief description of the changes and reference the related issue.
By contributing to Open Integration Engine, you agree that your contributions will be licensed under the Mozilla Public License (MPL) 2.0.
Thank you for your interest in improving Open Integration Engine.