1
1
# Contribution guidelines
2
2
3
- First of all: Thank you! ❤️
3
+ First of all: Thank you! We really appreciate your efforts to make 1build better ❤️
4
4
5
- Before sending a Pull Request, please make sure that you're assigned the task on a GitHub issue.
5
+ Create or find an issue you would like to implement:
6
+ - issues with the label ` help wanted ` are ready to be picked up and implemented
7
+ - review the existing issues and ensure that you are not going to create a duplicate
8
+ - create your issue and wait for comments from maintainers
9
+ - once the issue is discussed and assigned to you – feel free to implement
6
10
7
- - If a relevant issue already exists, discuss on the issue and get it assigned to yourself on GitHub.
8
- - If no relevant issue exists, open a new issue and get it assigned to yourself on GitHub.
9
-
10
-
11
- # Developing the 1build
11
+ # Developing 1build
12
12
13
13
1 . Prepare project
14
14
@@ -18,13 +18,13 @@ Before sending a Pull Request, please make sure that you're assigned the task on
18
18
pip install -r requirements.txt
19
19
```
20
20
21
- 2. Make Sure all existing tests are passing & have new tests needed
21
+ 2. Make sure that all the existing tests are passed, extend tests if needed
22
22
` ` ` sh
23
23
pytest
24
24
` ` `
25
25
3. Make sure you are following ` pep8` guidelines for linting
26
- 4. Update necessary documents if needed ( Readme etc)
26
+ 4. Update necessary documents if needed – Readme etc.
27
27
5. Submit pull request
28
28
6. Make sure all the checks are passing
29
29
7. Wait for maintainers to review the code
30
- 8. Thanks for you contribution :smile:
30
+ 8. Thanks for you contribution :smile:
0 commit comments