Skip to content

Commit 38c9ccf

Browse files
author
gibson9583
authored
#14 Add Contributing guide (#17)
* #14 Add Contributing guide Signed-off-by: Chris Gibson <cgibson@outlook.com>
1 parent 1ecd2d3 commit 38c9ccf

File tree

1 file changed

+64
-0
lines changed

1 file changed

+64
-0
lines changed

CONTRIBUTING.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
2+
# Contributing to Open Integration Engine
3+
4+
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.
5+
6+
The contribution process is straightforward and can be completed in a few simple steps:
7+
8+
## How to Contribute
9+
10+
### 1. Open an Issue
11+
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.
12+
13+
### 2. Fork the Repository
14+
Start by forking the [Open Integration Engine GitHub repository](https://github.com/OpenIntegrationEngine/engine) to your own GitHub account.
15+
16+
### 3. Clone Your Fork
17+
Clone your fork locally to your development environment:
18+
```bash
19+
git clone git@github.com:OpenIntegrationEngine/engine.git
20+
```
21+
22+
### 4. Make Changes
23+
Create a new branch for your feature or bug fix:
24+
```bash
25+
git checkout -b feature/your-feature-name
26+
```
27+
Implement the necessary changes, ensuring that they align with the project’s coding standards and practices.
28+
29+
### 5. Test Your Changes
30+
Before submitting your changes, please ensure that all tests pass and that your changes work as expected in your local environment.
31+
32+
### 6. Submit a Pull Request
33+
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.
34+
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.
35+
36+
## Reporting Bugs
37+
38+
If you encounter a bug, please report it using the **GitHub Issues Tracker**:
39+
1. **Search for existing issues** to check if the problem has already been reported.
40+
2. If the issue is not listed, create a new issue with the following information:
41+
- A clear and descriptive title.
42+
- Steps to reproduce the issue.
43+
- The expected vs. actual behavior.
44+
- Any relevant logs, error messages, or screenshots to help diagnose the issue.
45+
46+
## Suggesting Features
47+
48+
If you would like to suggest a new feature or enhancement:
49+
1. Open a new issue in the **GitHub Issues Tracker**.
50+
2. Label the issue as a **feature request**.
51+
3. Provide a detailed description of the feature and the problem it aims to solve.
52+
4. If applicable, include examples or use cases to demonstrate the value of the feature.
53+
54+
## Community Guidelines
55+
56+
- Be respectful and professional in all interactions.
57+
- Provide constructive feedback and suggestions.
58+
- Engage in discussions around pull requests and issues with an open and collaborative mindset.
59+
60+
## License
61+
62+
By contributing to **Open Integration Engine**, you agree that your contributions will be licensed under the [Mozilla Public License (MPL) 2.0](./LICENSE).
63+
64+
Thank you for your interest in improving **Open Integration Engine**.

0 commit comments

Comments
 (0)