Skip to content

Commit 1df0987

Browse files
committed
docs: add contributing desc
1 parent 486bbcd commit 1df0987

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

CONTRIBUTING.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,25 +36,45 @@ Found a bug or have a feature request? [Create an issue](https://github.com/volc
3636
- Steps to reproduce (for bugs)
3737
- Your environment (OS, Python version, MineContext version)
3838

39+
### Branch Naming Convention
40+
41+
Use descriptive branch names with appropriate prefixes:
42+
43+
| Prefix | Purpose | Example |
44+
|--------|---------|---------|
45+
| `feature/` or `feat/` | New features | `feature/add-notion-integration` |
46+
| `fix/` | Bug fixes | `fix/screenshot-capture-error` |
47+
| `hotfix/` | Critical production fixes | `hotfix/memory-leak` |
48+
| `docs/` | Documentation only | `docs/update-api-guide` |
49+
| `refactor/` | Code refactoring | `refactor/simplify-storage-layer` |
50+
| `test/` | Adding or updating tests | `test/add-processor-tests` |
51+
| `chore/` | Maintenance tasks | `chore/update-dependencies` |
52+
3953
### Submitting Code
4054

4155
1. **Create a branch**
4256

57+
Follow the branch naming convention above:
4358
```bash
4459
git checkout -b feature/your-feature-name
60+
# or
61+
git checkout -b fix/your-bug-fix
4562
```
63+
4664
2. **Make your changes**
4765

4866
- Follow [PEP 8](https://pep8.org/) style guidelines
4967
- Add tests for new features
5068
- Update documentation if needed
69+
5170
3. **Commit with clear messages**
5271

5372
```bash
5473
git commit -m "feat: add your feature description"
5574
# or
5675
git commit -m "fix: fix your bug description"
5776
```
77+
5878
4. **Push and create a Pull Request**
5979

6080
```bash

0 commit comments

Comments
 (0)