From 8a223282bea43a7e1363fd3e1c270411c6e6fd45 Mon Sep 17 00:00:00 2001 From: Chris Gibson Date: Thu, 3 Apr 2025 16:04:30 -0400 Subject: [PATCH 1/3] #14-Add Contributing Signed-off-by: Chris Gibson --- CONTRIBUTING.md | 60 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..cb22543fa --- /dev/null +++ b/CONTRIBUTING.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 86bbd3579efd78f1799f1f0d0fd7b5e5c804e20d Mon Sep 17 00:00:00 2001 From: Chris Gibson Date: Thu, 3 Apr 2025 16:22:35 -0400 Subject: [PATCH 2/3] Address feedback Signed-off-by: Chris Gibson --- CONTRIBUTING.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cb22543fa..af66580be 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,27 +7,30 @@ The contribution process is straightforward and can be completed in a few simple ## How to Contribute -### 1. Fork the Repository +### 1. Open an Issue +Before making any changes, please open an issue in the [GitHub Issues Tracker](https://github.com/OpenIntegrationEngine/engine/issues). This step helps us discuss the problem or feature before work begins, ensuring alignment and reducing redundant efforts. + +### 2. 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 +### 3. Clone Your Fork Clone your fork locally to your development environment: ```bash git clone git@github.com:OpenIntegrationEngine/engine.git ``` -### 3. Make Changes +### 4. 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 +### 5. 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. +### 6. 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 the related issue. ## Reporting Bugs From 5b5caf82c19e694a21674b93ea85ce930937433f Mon Sep 17 00:00:00 2001 From: Chris Gibson Date: Thu, 3 Apr 2025 16:28:24 -0400 Subject: [PATCH 3/3] Use Draft Pull Requests Signed-off-by: Chris Gibson --- CONTRIBUTING.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index af66580be..889fdaacb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -30,7 +30,8 @@ Implement the necessary changes, ensuring that they align with the project’s c Before submitting your changes, please ensure that all tests pass and that your changes work as expected in your local environment. ### 6. 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 the related issue. +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. ## Reporting Bugs