@@ -37,15 +37,15 @@ We welcome pull requests! To contribute code:
3737
3838#### Step 2: Create a Feature Branch
3939
40- Create a new branch for your changes: (Optional)
40+ Create a new branch for your changes:
4141
4242``` sh
43- git checkout -b feature-name
43+ git checkout -b feature-name
4444```
4545
4646#### Step 3: Make Changes and Test
4747
48- - Follow the project’ s coding style.
48+ - Follow the project' s coding style.
4949- Ensure your code is well-documented and includes meaningful commit messages.
5050- Run tests before submitting a pull request:
5151 ``` sh
@@ -59,7 +59,7 @@ Create a new branch for your changes: (Optional)
5959 ``` sh
6060 git push origin feature-name
6161 ```
62- 2 . Open a pull request from your fork’ s branch to the ` main ` branch of the original repository.
62+ 2 . Open a pull request from your fork' s branch to the ` master ` branch of the original repository.
63633 . Provide a detailed description of your changes.
64644 . Address any requested changes from maintainers.
6565
@@ -68,6 +68,11 @@ Create a new branch for your changes: (Optional)
6868- Follow PEP 8 for Python code styling.
6969- Use meaningful variable and function names.
7070- Maintain clear and concise documentation in the code.
71+ - Use 4 spaces for indentation, not tabs.
72+ - Use triple double quotes (""") for docstrings.
73+ - Include type hints for function parameters and return values.
74+ - Maximum line length should be 88 characters.
75+ - Use descriptive variable names that explain the purpose.
7176
7277### 5. Writing Tests
7378
@@ -77,17 +82,28 @@ Ensure new features and bug fixes include test cases. The project uses `pytest`
7782pytest
7883```
7984
80- If you add new features, create corresponding test cases under the ` tests/ ` directory.
85+ If you add new features, create corresponding test cases under the ` tests/ ` directory. Ensure your tests cover:
86+ - Normal expected operation
87+ - Edge cases
88+ - Error handling
8189
8290### 6. Documentation Contributions
8391
8492Help improve the documentation by submitting corrections, clarifications, or examples. Update the README or other documentation files as needed.
8593
94+ ### 7. Release Process
95+
96+ The project follows semantic versioning (MAJOR.MINOR.PATCH):
97+ - MAJOR version for incompatible API changes
98+ - MINOR version for new functionality in a backward-compatible manner
99+ - PATCH version for backward-compatible bug fixes
100+
101+ When contributing changes that would necessitate a version bump, please indicate the suggested version change in your PR description.
102+
86103## Code of Conduct
87104
88105Be respectful and follow the open-source community guidelines. Maintain a collaborative and inclusive environment.
89106
90107---
91108
92- Thank you for contributing! 🚀
93-
109+ Thank you for contributing! 🚀
0 commit comments