Skip to content

Commit 97db086

Browse files
committed
initalize the contributing document
1 parent cc406a7 commit 97db086

File tree

1 file changed

+54
-0
lines changed

1 file changed

+54
-0
lines changed

CONTRIBUTING.md

+54
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# Contributing Guidelines
2+
3+
Thank you for your interest in contributing to our project! Before you get
4+
started, please take a moment to review the following guidelines.
5+
6+
## Testing
7+
8+
Tests must be included for every new feature or bug fix. This helps ensure the stability and reliability of the codebase. Each archetype has an associated test file.
9+
10+
## Documentation
11+
12+
Documentation should accompany any updates or changes made to the project. This
13+
helps other contributors and users understand the purpose and functionality of
14+
the code. Documentation takes a couple of forms in this repository, we use
15+
README.md files, issues, and inline comments for documenting decisions. As some
16+
of these cannot be included in a commit, it is up to the contributor to
17+
indicate how they are documenting their addition.
18+
19+
## Pull Requests
20+
21+
Users cannot merge their own pull requests. All pull requests must be reviewed and approved by at least one other contributor.
22+
23+
### Writing a Pull Request
24+
25+
When submitting a pull request, please include the following:
26+
27+
- A clear and concise description of the changes made.
28+
- Any relevant references to files or desired features.
29+
- Steps to reproduce the issue (if applicable).
30+
- Any additional information that may be helpful for reviewers.
31+
32+
PRs are automatically checked to ensure that they include updates to the `CHANGELOG.md` file.
33+
**DO NOT MERGE A PR THAT DOESN'T PASS THIS TEST!**
34+
35+
### Tagging Pull Requests
36+
37+
When tagging your pull request, please use one of the following tags:
38+
39+
- Bug Fix: For correcting a bug.
40+
- Documentation: For updates to READMEs, text documents, licenses, or writing.
41+
- New Feature: For substantial contributions that were previously outside the scope of the code.
42+
- Example: For notebooks, code examples, outlines, or sample files.
43+
- Enhancement: For refinement work on existing features that add value to the project.
44+
45+
## Writing an Issue
46+
47+
When creating an issue, please ensure it includes the following:
48+
49+
- A description of the current state and the desired state.
50+
- Specific references to files or desired features.
51+
- Steps to reproduce the issue (if applicable).
52+
- A description of how the issue can be closed.
53+
54+
We appreciate your contributions and look forward to working with you!

0 commit comments

Comments
 (0)