Skip to content

Commit e15f613

Browse files
committed
Add information about time and financial donations to contributing guidelines
Signed-off-by: jonbartels <[email protected]>
1 parent 47e75ee commit e15f613

File tree

1 file changed

+51
-26
lines changed

1 file changed

+51
-26
lines changed

CONTRIBUTING.md

+51-26
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,58 @@
33

44
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.
55

6-
The contribution process is straightforward and can be completed in a few simple steps:
6+
## Community Guidelines
7+
8+
- Be respectful and professional in all interactions.
9+
- Provide constructive feedback and suggestions.
10+
- Engage in discussions around pull requests and issues with an open and collaborative mindset.
11+
12+
## Table of Contents
13+
14+
- [How to Contribute Time](#how-to-contribute-time)
15+
- [How to Contribute Money](#how-to-contribute-money)
16+
- [How to Contribute Code](#how-to-contribute-code)
17+
18+
## How to Contribute Time
19+
20+
Individuals can contribute code, issues, or questions at any time.
21+
22+
Corporations are encouraged to give time by allowing their staff to contribute to OIE with code, participation in the community, or other professional time.
23+
24+
Entities working on larger issues or offering significant or recurring contributions of time are encouraged to [contact the OIE Steering Committee](https://openintegrationengine.org/contact/). This allows us to make the most of the contributed time for mutual benefit.
25+
26+
27+
### Reporting Bugs
28+
29+
If you encounter a bug, please report it using the **GitHub Issues Tracker**:
30+
1. **Search for existing issues** to check if the problem has already been reported.
31+
2. If the issue is not listed, create a new issue with the following information:
32+
- A clear and descriptive title.
33+
- Steps to reproduce the issue.
34+
- The expected vs. actual behavior.
35+
- Any relevant logs, error messages, or screenshots to help diagnose the issue.
36+
37+
### Suggesting Features
38+
39+
If you would like to suggest a new feature or enhancement:
40+
1. Open a new issue in the [**GitHub Issues Tracker**](https://github.com/OpenIntegrationEngine/engine/issues).
41+
2. Label the issue as a **feature request**.
42+
3. Provide a detailed description of the feature and the problem it aims to solve.
43+
4. If applicable, include examples or use cases to demonstrate the value of the feature.
744

8-
## How to Contribute
45+
46+
## How to Contribute Money
47+
48+
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.
49+
50+
Small individual donations are appreciated, however your individual time is often more valuable to us than your currency.
51+
52+
Corporations can contribute by:
53+
* Investing money by paying or hiring developers [to contribute code](#how-to-contribute-code)
54+
* Directly contributing to OIE [by contacting the OIE Steering Committee](https://openintegrationengine.org/contact/)
55+
* Joining a sponsoring foundation. Learn which foundations are sponsoring the project [by contacting the OIE Steering Committee](https://openintegrationengine.org/contact/)
56+
57+
## How to Contribute Code
958

1059
### 1. Open an Issue
1160
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.
@@ -40,30 +89,6 @@ Before submitting your changes, please ensure that all tests pass and that your
4089
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.
4190
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.
4291

43-
## Reporting Bugs
44-
45-
If you encounter a bug, please report it using the **GitHub Issues Tracker**:
46-
1. **Search for existing issues** to check if the problem has already been reported.
47-
2. If the issue is not listed, create a new issue with the following information:
48-
- A clear and descriptive title.
49-
- Steps to reproduce the issue.
50-
- The expected vs. actual behavior.
51-
- Any relevant logs, error messages, or screenshots to help diagnose the issue.
52-
53-
## Suggesting Features
54-
55-
If you would like to suggest a new feature or enhancement:
56-
1. Open a new issue in the **GitHub Issues Tracker**.
57-
2. Label the issue as a **feature request**.
58-
3. Provide a detailed description of the feature and the problem it aims to solve.
59-
4. If applicable, include examples or use cases to demonstrate the value of the feature.
60-
61-
## Community Guidelines
62-
63-
- Be respectful and professional in all interactions.
64-
- Provide constructive feedback and suggestions.
65-
- Engage in discussions around pull requests and issues with an open and collaborative mindset.
66-
6792
## License
6893

6994
By contributing to **Open Integration Engine**, you agree that your contributions will be licensed under the [Mozilla Public License (MPL) 2.0](./LICENSE).

0 commit comments

Comments
 (0)