Contributing Guide¶

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¶

Report bugs at https://github.com/DataMedSci/pymchelper/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 or Implement Features¶

Look through the GitHub issues for bugs or features. Anything tagged with “bug” or “feature” is open to whoever wants to implement it.

Implement Features¶

Look through the GitHub issues for features. Anything tagged with “feature” is open to whoever wants to implement it.

Write Documentation¶

pymchelper could always use more documentation, whether as part of the official pymchelper 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/DataMedSci/pymchelper/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 :)

Get Started for GIT-aware developers¶

Ready to contribute? Here’s how to set up pymchelper for local development. We assume you are familiar with GIT source control system. If not you will other instruction at the end of this page.

Fork the pymchelper repo on GitHub.

Clone your fork locally:

$ git clone git@github.com:your_name_here/pymchelper.git

If you are not familiar with GIT, proceed to step 5, otherwise create a branch for local development:
```
$ cd pymchelper
$ git checkout -b feature/issue_number-name_of_your_bugfix_or_feature
```
Now you can make your changes locally.

As the software is prepared to be shipped as pip package, some modifications of PYTHONPATH variables are needed to run the code. Let us assume you are now in the same directory as setup.py file.

The standard way to execute Python scripts WILL NOT WORK. What users see as convertmc program, is basically pymchelper/run.py script:

$ python pymchelper/run.py --help

To have the code working, the PYTHONPATH has to be adjusted:

$ PYTHONPATH=. python pymchelper/run.py --help
 usage: run.py [-h] [-V] converter ...
 (...)

Make local changes to fix the bug or to implement a feature.
When you’re done making changes, check that your changes comply with PEP8 code quality standards (flake8 tests) and run unit tests with pytest:
```
$ flake8 pymchelper tests
$ pytest tests
```
To get flake8 and pytest, just pip install them.

Commit your changes and push your branch to GitHub:

$ git add .
$ git commit -m "Your detailed description of your changes."

Repeat points 4-6 until the work is done. Now its time to push the changes to remote repository:
```
$ git push origin feature/issue_number-name_of_your_bugfix_or_feature
```
Submit a pull request through the GitHub website to the master branch of git@github.com:DataMedSci/pymchelper.git repository.
Check the status of automatic tests ran by Travis system.

You can find them on the pull request webpage https://travis-ci.org/DataMedSci/pymchelper/pull_requests. In case some of the tests fails, fix the problem. Then commit and push your changes (steps 5-8).

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 extend the documentation where necessary.
The pull request should work for Python 2.7, 3.2, 3.3, 3.4 and 3.5. Check https://travis-ci.org/DataMedSci/pymchelper/pull_requests and make sure that the tests pass for all supported Python versions.

Get Started for non-GIT developers¶

Fetch the code from remote GIT repository to your local directory:
```
$ git clone git@github.com:DataMedSci/pymchelper.git
```
Follow steps 4-6 from the instruction for GIT-aware developers. To run code locally, prefix usual calls with PYTHONPATH=.:
```
$ PYTHONPATH=. python pymchelper/run.py --help
```
usage: run.py [-h] [-V] converter … (…)

Make your changes and check that they comply with PEP8 code quality standards (flake8 tests) and run all unit tests with pytest:

$ flake8 pymchelper tests
$ pytest tests/

Compress your working directory and send it to us by email (see authors), describing your changes.

Tips¶

To run full tests type:

pytest tests/

To run only a single test type:

pytest tests/test_file_to_run.py