-
Notifications
You must be signed in to change notification settings - Fork 67
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #30 from SparkPost/contributing
Create CONTRIBUTING file
- Loading branch information
Showing
1 changed file
with
48 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
# Contributing to python-sparkpost | ||
|
||
Transparency is one of our core values, and we encourage developers to contribute and become part of the SparkPost developer community. | ||
|
||
The following is a set of guidelines for contributing to python-sparkpost, | ||
which is hosted in the [SparkPost Organization](https://github.com/sparkpost) on GitHub. | ||
These are just guidelines, not rules, use your best judgment and feel free to | ||
propose changes to this document in a pull request. | ||
|
||
## Submitting Issues | ||
|
||
* You can create an issue [here](https://github.com/sparkpost/python-sparkpost/issues/new), but | ||
before doing that please read the notes below on debugging and submitting issues, | ||
and include as many details as possible with your report. | ||
* Include the version of python-sparkpost you are using. | ||
* Perform a [cursory search](https://github.com/issues?utf8=%E2%9C%93&q=is%3Aissue+user%3Asparkpost+repo%3Apython-sparkpost) | ||
to see if a similar issue has already been submitted. | ||
|
||
## Local development | ||
|
||
* Fork this repository | ||
* Clone your fork | ||
* Install virtualenv: ``pip install virtualenv`` | ||
* Run ``make install`` | ||
* Run ``source venv/bin/activate`` | ||
* Write code! | ||
|
||
## Contribution Steps | ||
|
||
### Guidelines | ||
|
||
- Provide documentation for any newly added code. | ||
- Provide tests for any newly added code. | ||
- Follow PEP8. | ||
|
||
1. Create a new branch named after the issue you’ll be fixing (include the issue number as the branch name, example: Issue in GH is #8 then the branch name should be ISSUE-8)) | ||
2. Write corresponding tests and code (only what is needed to satisfy the issue and tests please) | ||
* Include your tests in the 'test' directory in an appropriate test file | ||
* Write code to satisfy the tests | ||
3. Ensure automated tests pass | ||
4. Submit a new Pull Request applying your feature/fix branch to the develop branch | ||
|
||
## Testing | ||
|
||
Once you are set up for local development: | ||
|
||
* Run ``make test`` to test against your current Python environment | ||
* Open htmlcov/index.html to view coverage information |