Skip to content

Commit fd3f86f

Browse files
committed
doc: add contribution guidelines
1 parent 62fe11a commit fd3f86f

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

contributing.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Contributing to This Repository
2+
3+
Thank you for your interest in contributing! We welcome contributions of Python scripts and improvements to this repository.
4+
5+
## How to Contribute
6+
7+
1. **Discuss First**
8+
Before making any changes, please open an issue to discuss your idea with the maintainers. This helps us coordinate and avoid duplication.
9+
10+
2. **Make Your Contribution**
11+
- Fork the repository.
12+
- Create a new folder named after your script or its purpose (short and descriptive).
13+
- Add your Python script(s) inside this folder.
14+
- Include a `README.md` in that folder explaining what your script does and any prerequisites.
15+
- Update the main `README.md` by adding your script to the **List of Scripts** with its name, a brief description, and a link to your script folder.
16+
17+
3. **Open a Pull Request (PR)**
18+
- Link your PR to the issue you created earlier.
19+
- We will review your changes and provide feedback or merge it if everything looks good.
20+
21+
4. **Clean Up**
22+
Ensure any temporary install or build dependencies are removed before submitting your PR.
23+
24+
## First-Time Contributors
25+
26+
If this is your first time contributing to an open source project, check out this helpful guide:
27+
[How to Make Your First Contribution](https://opensource.guide/how-to-contribute/)
28+
29+
## Code of Conduct
30+
31+
We strive to maintain a welcoming and inclusive community. Please read and respect our [Code of Conduct](CODE_OF_CONDUCT.md) in all your interactions.

0 commit comments

Comments
 (0)