3. About#
3.2. Contributing#
Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
You can contribute in many ways:
3.2.1. Types of Contributions#
3.2.1.1. Report Bugs#
Report bugs at JannisHoch/pcrglobwb_utils#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.
3.2.1.2. Fix Bugs#
Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.
3.2.1.3. Implement Features#
Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.
3.2.1.4. Write Documentation#
pcrglobwb_utils could always use more documentation, whether as part of the official pcrglobwb_utils docs, in docstrings, or even on the web in blog posts, articles, and such.
3.2.1.5. Submit Feedback#
The best way to send feedback is to file an issue at JannisHoch/pcrglobwb_utils#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 :)
3.2.2. Get Started!#
Ready to contribute? Here’s how to set up pcrglobwb_utils for local development.
Fork the
pcrglobwb_utilsrepo on GitHub.Clone your fork locally
$ git clone git@github.com:your_name_here/pcrglobwb_utils.git
Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development
$ mkvirtualenv pcrglobwb_utils
$ cd pcrglobwb_utils/
$ python setup.py develop
Create a branch for local development
$ git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox
$ flake8 pcrglobwb_utils tests
$ python setup.py test or pytest
$ tox
To get flake8 and tox, just pip install them into your virtualenv.
Commit your changes and push your branch to GitHub:
$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature
Submit a pull request through the GitHub website.
3.2.3. Pull Request Guidelines#
Before you submit a pull request, check that it meets these guidelines:
The pull request should include tests.
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.rst.
The pull request should work for Python 3.8 or higher, and for PyPI. Check https://travis-ci.com/JannisHoch/pcrglobwb_utils/pull_requests and make sure that the tests pass for all supported Python versions.
3.2.4. Tips#
To run a subset of tests:
$ pytest tests.test_pcrglobwb_utils
3.2.5. Deploying#
A reminder for the maintainers on how to deploy. Make sure all your changes are committed (including an entry in HISTORY.rst). Then run:
$ bump2version patch # possible: major / minor / patch
$ git push
$ git push --tags
3.3. License#
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
pcrglobwb_utils - handy functions to work with PCR-GLOBWB input and output
Copyright (C) 2020 Jannis M. Hoch
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.
Also add information on how to contact you by electronic and paper mail.
You should also get your employer (if you work as a programmer) or school, if any, to sign a “copyright disclaimer” for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see http://www.gnu.org/licenses/.
The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read http://www.gnu.org/philosophy/why-not-lgpl.html.