Skip to content

Commit c5c53bb

Browse files
authored
🤝 Create CONTRIBUTING.md
1 parent 19379c6 commit c5c53bb

File tree

1 file changed

+58
-0
lines changed

1 file changed

+58
-0
lines changed

CONTRIBUTING.md

+58
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# CONTRIBUTING.md
2+
3+
First of all, thank you for considering contributing to our project. We value your time and your interest in this project, and we appreciate every contribution that helps us improve it. Below are some guidelines for contributing.
4+
5+
## Table of Contents
6+
7+
- [Getting Started](#getting-started)
8+
- [Pull Requests](#pull-requests)
9+
- [Code Style](#code-style)
10+
- [Commit Messages](#commit-messages)
11+
- [Documentation](#documentation)
12+
- [Contact](#contact)
13+
14+
## Getting Started
15+
16+
1. Ensure you have forked the repository and cloned your fork to your local machine. This will allow you to make and test your changes before pushing them for consideration.
17+
2. Create a new branch for your feature or bugfix. This keeps your changes separate from the main project and makes it easier to merge your changes in later.
18+
19+
```
20+
git checkout -b feature/AmazingFeature
21+
```
22+
23+
## Pull Requests
24+
25+
1. Commit your changes to your branch.
26+
```bash
27+
git commit -m 'Add some AmazingFeature'
28+
```
29+
30+
2. Push your branch to your fork of the repository on GitHub.
31+
```bash
32+
git push origin feature/AmazingFeature
33+
```
34+
35+
3. Open a Pull Request from your fork to our repository. Please provide a
36+
detailed explanation of your changes and reference any related issues.
37+
38+
## Code Style
39+
40+
We follow the [PEP 8](https://peps.python.org/pep-0008/) style guide for Python code. Please ensure your contributions adhere to this standard.
41+
42+
We recommend using a linter to check your code quality. You can check the documentation for [Visual Studio Code](https://code.visualstudio.com/docs/python/linting#_run-linting) or [Jetbrains Pycharm](https://github.com/leinardi/pylint-pycharm/blob/master/README.md) for more information.
43+
44+
For autocompletion, we recommend the [Tabnine](https://www.tabnine.com/install) plugin.
45+
46+
## Commit Messages
47+
48+
Please use clear and meaningful commit messages. This helps us understand the changes you've made and the reasoning behind them. If your commit resolves a specific issue, reference it in your commit message.
49+
50+
## Documentation
51+
52+
When adding new code, please use docstrings with **reStructuredText** format by adding triple double quotes **"""** after function definition. Add a brief function description, also for the parameters including the return value and its corresponding data type.
53+
54+
## Contact
55+
56+
If you have any questions or need further clarification on anything, feel free to reach out. We are here to help!
57+
58+
Back to [README](README.md).

0 commit comments

Comments
 (0)