Skip to content

Commit fa80d1e

Browse files
authored
Create CONTRIBUTING.md
1 parent 8fbd352 commit fa80d1e

1 file changed

Lines changed: 24 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# CONTRIBUTING
2+
3+
Thank you for your interest in contributing to the project!
4+
5+
### Core Contribution Steps:
6+
1. **Fork** the repository and create a branch: `feature/your-feature` or `fix/issue-number`.
7+
2. **Verify** that your branch passes all tests and static analysis locally:
8+
* `black .`
9+
* `isort --profile black .`
10+
* `flake8`
11+
* `mypy`
12+
* `pytest`
13+
3. **Describe** your changes in the PR: what was changed, why, and provide a brief usage example if applicable.
14+
4. **Add tests** for any new features or regression fixes.
15+
5. **Sign the CLA** (if required by the organization).
16+
17+
### Code Standards:
18+
* Follow **PEP8**.
19+
* Use **type hints** wherever possible.
20+
* Write compact commits with meaningful messages.
21+
22+
### Review Process:
23+
* PRs should generally contain **one logical task** or fix.
24+
* For major changes, please **open an issue** first to discuss the design before implementation.

0 commit comments

Comments
 (0)