Skip to content

Commit 8129824

Browse files
authored
add contrib guide. See #169 (#243)
1 parent 2080bf8 commit 8129824

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

CONTRIBUTING.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Contribution to Coronavirus Tracker API
2+
3+
First off, thanks for taking the time to contribute!
4+
Every commit supports the open source ecosystem in case of [COVID-19](https://en.wikipedia.org/wiki/2019%E2%80%9320_coronavirus_pandemic).
5+
6+
## Testing
7+
8+
We have a handful of unit tests to cover most of functions.
9+
Please write new test cases for new code you create.
10+
11+
## Submitting changes
12+
13+
* If you're unable to find an open issue, [open a new one](https://github.com/ExpDev07/coronavirus-tracker-api/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible
14+
* Open a new [GitHub Pull Request to coronavirus-tracker-api](https://github.com/ExpDev07/coronavirus-tracker-api/pulls) with a clear list of what you've done (read more about [pull requests](http://help.github.com/pull-requests/)). Include the relevant issue number if applicable.
15+
* We will love you forever if you include unit tests. We can always use more test coverage
16+
17+
## Your First Code Contribution
18+
19+
Unsure where to begin contributing to coronavirus-tracker-api ? You can start by looking through these issues labels:
20+
21+
* [Enhancement issues](https://github.com/ExpDev07/coronavirus-tracker-api/labels/enhancement) - issues for new feature or request
22+
* [Help wanted issues](https://github.com/ExpDev07/coronavirus-tracker-api/labels/help%20wanted) - extra attention is needed
23+
* [Documentation issues](https://github.com/ExpDev07/coronavirus-tracker-api/labels/documentation) - improvements or additions to documentation
24+
25+
## Styleguide
26+
27+
Please follow [PEP8](https://www.python.org/dev/peps/pep-0008/) guide.
28+
See [Running Test](./README.md#running-tests), [Linting](./README.md#linting) and [Formatting](./README.md#formatting) sections for further instructions to validate your change.
29+
30+
31+
We encourage you to pitch in and join the [Coronavirus Tracker API Team](https://github.com/ExpDev07/coronavirus-tracker-api#contributors-)!
32+
33+
Thanks! :heart: :heart: :heart:
34+
35+
[Coronavirus Tracker API Team](https://github.com/ExpDev07/coronavirus-tracker-api#contributors-)

0 commit comments

Comments
 (0)