Skip to content

Commit e4eeb4c

Browse files
authored
Create CONTRIBUTING.md
1 parent 0de12d8 commit e4eeb4c

1 file changed

Lines changed: 30 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Contributing
2+
3+
Thank you for taking the time to contribute to the project. The following set of guidelines will help you with your contribution and explain the review process.
4+
5+
6+
## Reporting Bugs / Proposing New Features
7+
8+
If you discover a bug or want to propose a new feature or enhancement to the code or documentation, please check whether the problem has already been reported in the [Issues](https://github.com/ZigRazor/CXXStateTree/issues).
9+
10+
If not, open a new issue and state the problem. Please provide a clear summary of the problem, what behavior you have expected and what behavior you have actually observed. If possible, create a *Minimal Reproducable Example* that demonstrates the problem.
11+
12+
13+
## Submitting Changes
14+
15+
We also highly welcome code contributions via pull requests. Note that your changes - after acceptance - will be offered under the **Apache 2.0** license. For more information, see the [LICENSE](https://github.com/ZigRazor/CXXStateTree/blob/master/LICENSE).
16+
17+
To create and submit your changes, follow the standard *Fork & Pull Request Workflow*:
18+
19+
1. Fork the project and switch to a new suitably named branch.
20+
2. Create one or more commits that reflect the changes you have made. Each commit should be self-contained, atomic and buildable. Therefore, split multiple features into different commits and include fixups in the related commit instead of creating a new one. If you add new functionality, please also add related tests.
21+
3. Test the changes on your local machine. For this, the provided scripts will help you to build the code and run the unit tests. See the [README](https://github.com/ZigRazor/CXXStateTree/blob/master/README.md) for details.
22+
4. Push the branch to your fork.
23+
5. Open a new pull request and summarize the problem and your solution. If there is a related issue, please mention it too.
24+
25+
Once you have submitted the pull request, your changes will be reviewed. You will receive feedback in two different forms:
26+
27+
1. **Automatic review**. Each pull request will be automatically tested using *Continuous Integration* tools. If a test fails, take a look at the error and fix the problem.
28+
2. **Manual human review**. In addition, your code will be manually reviewed by the project maintainers. Incorporate their feedback to improve the quality of your contribution.
29+
30+
After the review is complete and all tests pass, your pull request will be accepted and merged.

0 commit comments

Comments
 (0)