You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+4-2
Original file line number
Diff line number
Diff line change
@@ -13,6 +13,7 @@ Please note that we have a code of conduct that we need to follow moving forward
13
13
We use github to host code, to track issues and feature requests, as well as accept pull requests.
14
14
15
15
## We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests
16
+
16
17
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:
17
18
18
19
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]
32
33
## Write bug reports with detail, background, and sample code
33
34
[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.
34
35
35
-
**Great Bug Reports** tend to have:
36
+
*Great Bug Reports* tend to have:
36
37
37
38
- A quick summary and/or background
38
39
- Steps to reproduce
@@ -42,9 +43,10 @@ We use GitHub issues to track public bugs. Report a bug by [opening a new issue]
42
43
- What actually happens
43
44
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
44
45
45
-
People *love* thorough bug reports. I'm not even kidding.
46
+
People love thorough bug reports. I'm not even kidding.
46
47
47
48
## 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`
48
50
49
51
## License
50
52
By contributing, you agree that your contributions will be licensed under its MIT License.
0 commit comments