Newer
Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
# Contributing to this Project
First off, thank you for considering contributing to our project. It's people like you that make this project such a great one.
## How to Contribute
We welcome contributions from everyone. Here are the steps to get started
### General Guidelines
**PEP 8**
We follow [PEP 8](https://pep8.org/), the Python community's style guide. Please ensure your code adheres to this standard. This includes things like indentation, whitespace, line length, and more.
**Variable Names**
Use descriptive names for variables, functions, classes, modules, and other Python entities. Follow the naming conventions defined in PEP 8. For example, variable and function names should be `lowercase_with_underscores`, class names should be `CapWords`, and so on.
**Docstrings**
Include docstrings in your code to explain what your functions, methods, and classes do. We follow [PEP 257](https://www.python.org/dev/peps/pep-0257/) for docstring conventions.
**Type Annotations**
We encourage the use of type annotations as defined in [PEP 484](https://www.python.org/dev/peps/pep-0484/). This helps make the code more readable and self-documenting.
**Black Formatter**
Before submitting your code, format it with [Black](https://black.readthedocs.io/en/stable/), the uncompromising Python code formatter. This ensures a consistent code style throughout the project. You can install Black with pip (`pip install black`) and run it on your Python file or directory like this:
```zsh
poetry run black .
```
### Setting up the project for development
1. **Fork the Repository**
Start by forking the repository. This creates your own copy of the project where you can make your changes. You can fork the repository by clicking the "Fork" button at the top right of this page.
2. **Clone the Repository**
After forking, clone the repository to your local machine:
```zsh
git clone https://gitlab.com/<your-username>/<repository-name>.git
```
**NOTE**: Take a look at the README.md for installation instructions.
3. **Create a New Branch**
Navigate to your cloned repository and create a new branch where you'll make your changes:
```zsh
git checkout -b <branch-name>
```
Replace ```<branch-name>``` with a descriptive name for your branch.
4. **Make Your Changes**
Now you can start making changes to the project. Add new files, modify existing ones, fix bugs, implement new features, etc.
5. **Commit Your Changes**
Once you're done making changes, commit them with a descriptive commit message:
```zsh
git commit -am "Your detailed commit message"
```
6. **Push Your Changes**
Push your changes to your forked repository on GitLab:
```zsh
git push origin <branch-name>
```
7. **Open a Merge Request**
Finally, navigate to your forked repository on GitLab and click the "New merge request" button. \
Select your branch from the dropdown and click "Submit merge request".