Skip to content

Commit 2c9aa9a

Browse files
authored
Create CONTRIBUTING.md
1 parent 0a5b935 commit 2c9aa9a

File tree

1 file changed

+76
-0
lines changed

1 file changed

+76
-0
lines changed

CONTRIBUTING.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Contributing to insert-tools
2+
3+
Thanks for your interest in contributing! We welcome all contributions — bug reports, feature suggestions, code improvements, documentation, and more.
4+
5+
## How to Contribute
6+
7+
### 1. Fork the Repository
8+
9+
Click the "Fork" button in the top right corner of the [repo](https://github.com/castengine/insert-tools).
10+
11+
### 2. Clone Your Fork
12+
13+
```bash
14+
git clone https://github.com/yourusername/insert-tools.git
15+
cd insert-tools
16+
```
17+
18+
### 3. Create a Feature Branch
19+
20+
```bash
21+
git checkout -b feature/your-feature-name
22+
```
23+
24+
### 4. Make Changes and Commit
25+
26+
Make your changes, and commit them:
27+
28+
```bash
29+
git add .
30+
git commit -m "Add a clear message about what you changed"
31+
```
32+
33+
### 5. Push to GitHub
34+
35+
```bash
36+
git push origin feature/your-feature-name
37+
```
38+
39+
### 6. Create a Pull Request
40+
41+
Go to your forked repository, click "New Pull Request", and follow the instructions.
42+
43+
---
44+
45+
## 🐛 Reporting Bugs
46+
47+
- Use GitHub [Issues](https://github.com/castengine/insert-tools/issues)
48+
- Please provide steps to reproduce, expected vs actual behavior, and environment info (OS, Python version, etc.)
49+
50+
---
51+
52+
## 💡 Feature Suggestions
53+
54+
Open an issue and label it with `enhancement`. Describe:
55+
- What problem this feature solves
56+
- How it should work
57+
58+
---
59+
60+
## 📋 Code Style
61+
62+
- Use `black` or `isort` for formatting
63+
- Keep functions small and clear
64+
- Write docstrings and comments for clarity
65+
66+
---
67+
68+
## ✅ Checklist Before Submitting
69+
70+
- [ ] Code compiles / runs without error
71+
- [ ] Tests pass (if applicable)
72+
- [ ] Includes documentation or examples (if needed)
73+
74+
---
75+
76+
Thank you for contributing 🙏

0 commit comments

Comments
 (0)