Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
You can contribute in many ways:
Types of Contributions¶
Report bugs at https://gitlab.ethz.ch/hvl_priv/pyMETHES/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.
Look through the GitLab issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.
Look through the GitLab issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.
pyMETHES could always use more documentation, whether as part of the official pyMETHES docs, in docstrings, or even on the web in blog posts, articles, and such.
The best way to send feedback is to file an issue at https://gitlab.ethz.ch/hvl_priv/pyMETHES/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 :)
Ready to contribute? Here’s how to set up pyMETHES for local development.
Clone pyMETHES repo from GitLab.
$ git clone email@example.com:your_name_here/pyMETHES.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 pyMETHES $ cd pyMETHES/ $ python setup.py develop $ pip install -r requirements_dev.txt
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 pyMETHES tests $ python setup.py test # or py.test $ tox # test all supported Python environments
Commit your changes and push your branch to GitLab:
$ git add . $ git commit -m "Your detailed description of your changes." $ git push origin name-of-your-bugfix-or-feature
Submit a merge request through the GitLab website.
Merge Request Guidelines¶
Before you submit a merge request, check that it meets these guidelines:
The merge request should include tests.
If the merge 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 merge request should work for Python 3.7. Check https://gitlab.ethz.ch/hvl_priv/pyMETHES/merge_requests and make sure that the tests pass for all supported Python versions.
To run tests from a single file:
$ py.test tests/test_sample.py
or a single test function:
$ py.test tests/test_sample.py::test_pass
To add dependency, edit appropriate
*requirementsvariable in the
setup.pyfile and re-run:
$ python setup.py develop
To generate a PDF version of the Sphinx documentation instead of HTML use:
$ rm -rf docs/pyMETHES.rst docs/modules.rst docs/_build && sphinx-apidoc -o docs/ pyMETHES && python -msphinx -M latexpdf docs/ docs/_build
This requires a local installation of a LaTeX distribution, e.g. MikTeX.
A reminder for the maintainers on how to deploy. Create release-N.M.K branch. Make sure all your changes are committed (including an entry in HISTORY.rst). Then run:
$ bumpversion patch # possible: major / minor / patch $ git push $ git push --tags $ make release
Merge the release branch into master and devel branches with
Optionally, go to https://gitlab.ethz.ch/hvl_priv/pyMETHES/tags/vM.N.P/release/edit and add release notes (e.g. changes lists).