From 40b7b6bcadff22de590269c9385a28e2d8c62800 Mon Sep 17 00:00:00 2001 From: cgibson Date: Thu, 3 Apr 2025 14:27:55 -0400 Subject: [PATCH 1/2] #14 - Add CONTRIBUTING.md Baseline contributing doc --- CONTIBUTING.md | 60 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 CONTIBUTING.md diff --git a/CONTIBUTING.md b/CONTIBUTING.md new file mode 100644 index 000000000..cb22543fa --- /dev/null +++ b/CONTIBUTING.md @@ -0,0 +1,60 @@ + +# Contributing to Open Integration Engine + +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. + +The contribution process is straightforward and can be completed in a few simple steps: + +## How to Contribute + +### 1. Fork the Repository +Start by forking the [Open Integration Engine GitHub repository](https://github.com/OpenIntegrationEngine/engine) to your own GitHub account. + +### 2. Clone Your Fork +Clone your fork locally to your development environment: +```bash +git clone git@github.com:OpenIntegrationEngine/engine.git +``` + +### 3. Make Changes +Create a new branch for your feature or bug fix: +```bash +git checkout -b feature/your-feature-name +``` +Implement the necessary changes, ensuring that they align with the project’s coding standards and practices. + +### 4. Test Your Changes +Before submitting your changes, please ensure that all tests pass and that your changes work as expected in your local environment. + +### 5. Submit a Pull Request +Once your changes are ready, push them to your fork and create a pull request (PR) from your branch to the `main` branch of the project. Include a brief description of the changes and reference any relevant issues. + +## Reporting Bugs + +If you encounter a bug, please report it using the **GitHub Issues Tracker**: +1. **Search for existing issues** to check if the problem has already been reported. +2. 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. + +## Suggesting Features + +If you would like to suggest a new feature or enhancement: +1. Open a new issue in the **GitHub Issues Tracker**. +2. Label the issue as a **feature request**. +3. Provide a detailed description of the feature and the problem it aims to solve. +4. If applicable, include examples or use cases to demonstrate the value of the feature. + +## Community Guidelines + +- 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. + +## License + +By contributing to **Open Integration Engine**, you agree that your contributions will be licensed under the [Mozilla Public License (MPL) 2.0](./LICENSE). + +Thank you for your interest in improving **Open Integration Engine**. From a1a112e323ca4ae85cc69d529a08cc16b4e5b329 Mon Sep 17 00:00:00 2001 From: cgibson Date: Thu, 3 Apr 2025 14:27:55 -0400 Subject: [PATCH 2/2] #14 - Add CONTRIBUTING.md Baseline contributing doc Signed-off-by: Chris Gibson --- CONTIBUTING.md | 60 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 CONTIBUTING.md diff --git a/CONTIBUTING.md b/CONTIBUTING.md new file mode 100644 index 000000000..cb22543fa --- /dev/null +++ b/CONTIBUTING.md @@ -0,0 +1,60 @@ + +# Contributing to Open Integration Engine + +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. + +The contribution process is straightforward and can be completed in a few simple steps: + +## How to Contribute + +### 1. Fork the Repository +Start by forking the [Open Integration Engine GitHub repository](https://github.com/OpenIntegrationEngine/engine) to your own GitHub account. + +### 2. Clone Your Fork +Clone your fork locally to your development environment: +```bash +git clone git@github.com:OpenIntegrationEngine/engine.git +``` + +### 3. Make Changes +Create a new branch for your feature or bug fix: +```bash +git checkout -b feature/your-feature-name +``` +Implement the necessary changes, ensuring that they align with the project’s coding standards and practices. + +### 4. Test Your Changes +Before submitting your changes, please ensure that all tests pass and that your changes work as expected in your local environment. + +### 5. Submit a Pull Request +Once your changes are ready, push them to your fork and create a pull request (PR) from your branch to the `main` branch of the project. Include a brief description of the changes and reference any relevant issues. + +## Reporting Bugs + +If you encounter a bug, please report it using the **GitHub Issues Tracker**: +1. **Search for existing issues** to check if the problem has already been reported. +2. 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. + +## Suggesting Features + +If you would like to suggest a new feature or enhancement: +1. Open a new issue in the **GitHub Issues Tracker**. +2. Label the issue as a **feature request**. +3. Provide a detailed description of the feature and the problem it aims to solve. +4. If applicable, include examples or use cases to demonstrate the value of the feature. + +## Community Guidelines + +- 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. + +## License + +By contributing to **Open Integration Engine**, you agree that your contributions will be licensed under the [Mozilla Public License (MPL) 2.0](./LICENSE). + +Thank you for your interest in improving **Open Integration Engine**.