Skip to content

Commit 79aceb9

Browse files
add CONTRIBUTING.md
1 parent a9f8a78 commit 79aceb9

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

CONTRIBUTING.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Contributing
2+
3+
Thank you for considering contributing to **Htool-DDM**! We welcome bug reports, feature suggestions, and pull requests.
4+
5+
## Opening issues
6+
7+
If you encounter a bug or have a question, please [open an issue](https://github.com/htool-ddm/htool/issues).
8+
When reporting a bug, include:
9+
10+
- a clear description of the problem,
11+
- the expected behavior,
12+
- a minimal, reproducible example (if possible),
13+
- your environment (compiler, OS, library versions).
14+
15+
## Submitting changes (Pull Requests)
16+
17+
To learn how to submit a pull request, please refer to GitHub’s
18+
[pull request documentation](https://docs.github.com/fr/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).
19+
20+
Before your pull request can be merged into `main`:
21+
22+
1. **Tests must run successfully.**
23+
2. **Code style and formatting must follow project standards.**
24+
25+
Instructions for running tests locally and applying formatting can be found in the
26+
[Htool developer guide](https://htool-ddm.pages.math.cnrs.fr/cpp_api/developer_guide.html#developer-guide).
27+
28+
## Code Style and Guidelines
29+
30+
- Follow the project’s formatting rules (see [developer guide](https://htool-ddm.pages.math.cnrs.fr/cpp_api/developer_guide.html#formatting)).
31+
- Write clear commit messages.
32+
- Keep pull requests focused and reasonably small.
33+
34+
---
35+
36+
Thank you again for helping improve Htool-DDM!

0 commit comments

Comments
 (0)