Skip to content

Commit 58479ab

Browse files
docs: Contribution guidelines (#239)
* docs: add contribution convention section * docs: add contributing guidelines
1 parent ffd350e commit 58479ab

File tree

2 files changed

+27
-0
lines changed

2 files changed

+27
-0
lines changed

CONTRIBUTING.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Contributing
2+
👍🎉 First off, thanks for taking the time to contribute! 🎉👍
3+
4+
When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
5+
6+
Please note we have a [code of conduct](https://github.com/PythonFreeCourse/lms/blob/master/CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.
7+
8+
## Pull Requests
9+
Create feature branches.
10+
11+
One pull request per feature - If you want to do more than one thing, send multiple pull requests.
12+
13+
Send coherent history - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](https://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
14+
15+
## Guide
16+
1. Fork the project.
17+
2. Create a new branch (`git checkout -b 'branch name'`).
18+
3. Commit your changes (`git commit -m 'Add something new'`).
19+
4. Push to the branch (`git push -u origin 'branch name'`).
20+
5. Open a Pull Request.
21+
22+
## Style Guide
23+
Follow the [commit messages specification](https://www.conventionalcommits.org/en/v1.0.0/).
24+
25+
Happy coding!

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,3 +93,5 @@ pip install -r requirements.txt
9393
pip install -r dev_requirements.txt
9494
py.test -vvv
9595
```
96+
### Contributing
97+
View [contributing guidelines](https://github.com/PythonFreeCourse/lms/blob/master/CONTRIBUING.md).

0 commit comments

Comments
 (0)