Skip to content

Commit 2118110

Browse files
authoredNov 11, 2023
Create CONTRIBUTING.md
1 parent 0279f21 commit 2118110

File tree

1 file changed

+58
-0
lines changed

1 file changed

+58
-0
lines changed
 

‎CONTRIBUTING.md

+58
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Contributing to diart
2+
3+
Thank you for considering contributing to diart! We appreciate your time and effort to help make this project better.
4+
5+
## Before You Start
6+
7+
1. **Search for Existing Issues or Discussions:**
8+
- Before opening a new issue or discussion, please check if there's already an existing one related to your topic. This helps avoid duplicates and keeps discussions centralized.
9+
10+
2. **Discuss Your Contribution:**
11+
- If you plan to make a significant change, it's advisable to discuss it in an issue first. This ensures that your contribution aligns with the project's goals and avoids duplicated efforts.
12+
13+
3. **Questions about diart:**
14+
- For general questions about diart, use the discussion space on GitHub. This helps in fostering a collaborative environment and encourages knowledge-sharing.
15+
16+
## Opening Issues
17+
18+
If you encounter a problem with diart or want to suggest an improvement, please follow these guidelines when opening an issue:
19+
20+
- **Bug Reports:**
21+
- Clearly describe the error, including any relevant stack traces.
22+
- Provide a minimal, reproducible example that demonstrates the issue.
23+
- Mention the version of diart you are using (as well as any dependencies related to the bug).
24+
25+
- **Feature Requests:**
26+
- Clearly outline the new feature you are proposing.
27+
- Explain how it would benefit the project.
28+
29+
## Opening Pull Requests
30+
31+
We welcome and appreciate contributions! To ensure a smooth review process, please follow these guidelines when opening a pull request:
32+
33+
- **Create a Branch:**
34+
- Work on your changes in a dedicated branch created from `develop`.
35+
36+
- **Commit Messages:**
37+
- Write clear and concise commit messages, explaining the purpose of each change.
38+
39+
- **Documentation:**
40+
- Update documentation when introducing new features or making changes that impact existing functionality.
41+
42+
- **Tests:**
43+
- If applicable, add or update tests to cover your changes.
44+
45+
- **Code Style:**
46+
- Follow the existing coding style of the project. We use `black` and `isort`.
47+
48+
- **Discuss Before Major Changes:**
49+
- If your PR includes significant changes, discuss it in an issue first.
50+
51+
- **Follow the existing workflow:**
52+
- Make sure to open your PR against `develop` (**not** `main`).
53+
54+
## Thank You
55+
56+
Your contributions make diart better for everyone. Thank you for your time and dedication!
57+
58+
Happy coding!

0 commit comments

Comments
 (0)