-
Notifications
You must be signed in to change notification settings - Fork 35
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merging dev: Contrubution.md and minor change (#46)
* version 0.2.7 dev * .gitignore added (#19) * Fix NameError (#28) * Fix NameError * Fix test definition testEncodeUidSuccess * Assign ret * Version 0.2.8 (#32) * added pypi distribution dir * updated to 0.2.8 * removed irregularities in License * Add badges (#34) * [NEW] Add LICENSE badge * [NEW] Add pypi package version badge * Moving PyPi badge after Travis badge (#38) * Merging dev: added badges (#35) * version 0.2.7 dev * .gitignore added (#19) * Fix NameError (#28) * Fix NameError * Fix test definition testEncodeUidSuccess * Assign ret * Version 0.2.8 (#32) * added pypi distribution dir * updated to 0.2.8 * removed irregularities in License * Add badges (#34) * [NEW] Add LICENSE badge * [NEW] Add pypi package version badge * Moving PyPi badge after Travis badge * [NEW] Add 'CONTRIBUTING.md' file (#45)
- Loading branch information
1 parent
081ce86
commit ff30653
Showing
2 changed files
with
103 additions
and
1 deletion.
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,102 @@ | ||
# Contributing | ||
|
||
Contributions are welcome, and they are greatly appreciated! Every | ||
little bit helps, and credit will always be given. | ||
|
||
## Get Started! | ||
|
||
Ready to contribute? Here's how to set up `PyBeacon` for local development. | ||
You can contribute in many ways: | ||
|
||
1. Fork the `PyBeacon` repo on GitHub. | ||
2. Clone your fork locally: | ||
|
||
```shell | ||
$ git clone git@github.com:your_name_here/PyBeacon.git | ||
``` | ||
|
||
3. Install your local copy into a virtualenv. Assuming you have virtualenv installed, this is how you set up your fork for local development: | ||
|
||
```shell | ||
$ cd PyBeacon/ | ||
$ virtualenv env | ||
$ source env/bin/activate | ||
$ python setup.py develop | ||
$ pip install coveralls pytest pytest-cov | ||
``` | ||
|
||
4. Create a branch for local development: | ||
|
||
```shell | ||
$ git checkout -b name-of-your-bugfix-or-feature | ||
``` | ||
Now you can make your changes locally. | ||
|
||
5. When you're done making changes, check that your changes pass the test: | ||
|
||
```shell | ||
$ py.test | ||
``` | ||
|
||
6. Commit your changes and push your branch to GitHub:: | ||
|
||
```shell | ||
$ git add . | ||
$ git commit -m "Your detailed description of your changes." | ||
$ git push origin name-of-your-bugfix-or-feature | ||
``` | ||
|
||
7. Submit a pull request through the [GitHub website](https://github.com/nirmankarta/PyBeacon). | ||
|
||
## Types of Contributions | ||
|
||
You can contribute in many ways: | ||
|
||
### Report Bugs | ||
|
||
Report bugs at https://github.com/nirmankarta/PyBeacon/issues. | ||
|
||
If you are reporting a bug, please include: | ||
|
||
* Your operating system name and version. | ||
* Any details about your local setup that might be helpful in troubleshooting. | ||
* Detailed steps to reproduce the bug. | ||
|
||
### Fix Bugs | ||
|
||
Look through the [GitHub issues](https://github.com/nirmankarta/PyBeacon/issues) for bugs. Anything tagged with "bug" | ||
and "help wanted" is open to whoever wants to implement it. | ||
|
||
### Implement Features | ||
|
||
Look through the GitHub issues for features. Anything tagged with "enhancement" | ||
and "help wanted" is open to whoever wants to implement it. | ||
|
||
### Write Documentation | ||
|
||
PyBeacon could always use more documentation, whether as part of the | ||
official PyBeacon docs, in docstrings, or even on the web in blog posts, | ||
articles, and such. | ||
|
||
### Submit Feedback | ||
|
||
The best way to send feedback is to file an issue at https://github.com/nirmankarta/PyBeacon/issues. | ||
|
||
If you are proposing a feature: | ||
|
||
* Explain in detail how it would work. | ||
* Keep the scope as narrow as possible, to make it easier to implement. | ||
* Remember that this is a volunteer-driven project, and that contributions | ||
are welcome :) | ||
|
||
## Pull Request Guidelines | ||
|
||
Before you submit a pull request, check that it meets these guidelines: | ||
|
||
1. The pull request should include tests. | ||
2. If the pull request adds functionality, the docs should be updated. Put | ||
your new functionality into a function with a docstring, and add the | ||
feature to the list in README.md. | ||
3. The pull request should work for Python 2.7+ and 3.3+ and later. Check | ||
https://travis-ci.org/PyBeacon/PyBeacon/pull_requests | ||
and make sure that the tests pass for all supported Python versions. |
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