Skip to content

Commit 0169d54

Browse files
jbreue16schmoelder
andauthored
Update contributor's guide (#502)
Co-authored-by: Johannes Schmölder <[email protected]>
1 parent 8f1bf2b commit 0169d54

File tree

1 file changed

+41
-3
lines changed

1 file changed

+41
-3
lines changed

CONTRIBUTING.md

Lines changed: 41 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,46 @@
11
## Contributing
22

33
CADET-Core is an open-source project and we are very happy to accept contributions from the community.
4-
Please feel free to open issues or submit patches (preferably as pull requests) any time.
5-
For planned larger contributions, it is often beneficial to get in contact with us first, e.g. through the [CADET forum](https://forum.cadet-web.de/).
4+
Please feel free to open issues or submit patches (preferably as pull requests) at any time.
5+
For planned larger contributions, we would encourage you to get in touch with us first, e.g. through the [CADET forum](https://forum.cadet-web.de/).
66

7-
For detailed information on how to contribute, including guidelines, coding standards, and best practices, please refer to our [Developer Guide](https://cadet.github.io/master/developer_guide/index.html).
7+
For detailed information on how to contribute, including installation, dependencies, code style, testing, publishing, or model expansion, please refer to our [Developer Guide](https://cadet.github.io/master/developer_guide/index.html).
88

9+
## Issues & Pull Requests
10+
11+
Follow our [issue and PR templates](.github/ISSUE_TEMPLATE/) and [code of conduct](CODE_OF_CONDUCT.md).
12+
13+
### Issues vs. Pull Requests
14+
15+
We use **GitHub issues** for:
16+
17+
* Reporting bugs
18+
* Suggesting new features
19+
* Discussing technical problems and ideas
20+
21+
Please use an appropriate provided template and ensure your description and instructions are clear.
22+
23+
**Pull Requests** should be submitted after your changes are complete and tested.
24+
Make sure your PR addresses one issue or feature to keep reviews manageable.
25+
Reference related issues in your PR description.
26+
27+
## Branch Policy
28+
29+
We use a branch naming convention to keep contributions organized:
30+
31+
* **Feature branches**: `feature/your-feature-name`
32+
* **Bug fixes**: `fix/short-description`
33+
* **Hotfixes**: `hotfix/issue-description`
34+
* **Documentation updates**: `docs/update-description`
35+
36+
## Contributor License Agreement
37+
38+
Review our [CLA](CLA.md) before submitting your first PR.
39+
40+
## Documentation
41+
42+
Steps for building the documentation are described in [doc/README.md](doc/README.md).
43+
44+
## License
45+
46+
This project is licensed under the [GPL-3.0 License](LICENSE.txt).

0 commit comments

Comments
 (0)