Skip to content

Commit e28a5ef

Browse files
author
Tristán
committed
Added Coding Style explanation
1 parent 465088a commit e28a5ef

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

CONTRIBUTING.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Please note that we have a code of conduct that we need to follow moving forward
1313
We use github to host code, to track issues and feature requests, as well as accept pull requests.
1414

1515
## We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests
16+
1617
Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests:
1718

1819
1. Fork the repo and create your branch from `main`.
@@ -32,7 +33,7 @@ We use GitHub issues to track public bugs. Report a bug by [opening a new issue]
3233
## Write bug reports with detail, background, and sample code
3334
[This is an example](http://stackoverflow.com/q/12488905/180626) of a bug report I wrote, and I think it's not a bad model. Here's [another example from Craig Hockenberry](http://www.openradar.me/11905408), an app developer whom I greatly respect.
3435

35-
**Great Bug Reports** tend to have:
36+
*Great Bug Reports* tend to have:
3637

3738
- A quick summary and/or background
3839
- Steps to reproduce
@@ -42,9 +43,10 @@ We use GitHub issues to track public bugs. Report a bug by [opening a new issue]
4243
- What actually happens
4344
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
4445

45-
People *love* thorough bug reports. I'm not even kidding.
46+
People love thorough bug reports. I'm not even kidding.
4647

4748
## Use a Consistent Coding Style
49+
You can check [here](https://docs.python-guide.org/writing/style/) for more information about a good coding style. It's important to respect and follow it up to keep good practices. If it's difficult for you please, take in consideration use `flake8`
4850

4951
## License
5052
By contributing, you agree that your contributions will be licensed under its MIT License.

0 commit comments

Comments
 (0)