Skip to content

Latest commit

 

History

History
155 lines (101 loc) · 8.31 KB

CONTRIBUTING.md

File metadata and controls

155 lines (101 loc) · 8.31 KB
Raw

Guidelines for Contributing

As a scientific community-driven software project, PyMC welcomes contributions from interested individuals or groups. These guidelines are provided to give potential contributors information to make their contribution compliant with the conventions of the PyMC project, and maximize the probability of such contributions to be merged as quickly and efficiently as possible.

There are 4 main ways of contributing to the PyMC project (in descending order of difficulty or scope):

  • Adding new or improved functionality to the existing codebase
  • Fixing outstanding issues (bugs) with the existing codebase. They range from low-level software bugs to higher-level design problems.
  • Contributing or improving the documentation (docs) or examples (pymc/examples)
  • Submitting issues related to bugs or desired enhancements

Opening issues

We appreciate being notified of problems with the existing PyMC code. We prefer that issues be filed the on Github Issue Tracker, rather than on social media or by direct email to the developers.

Please verify that your issue is not being currently addressed by other issues or pull requests by using the GitHub search tool to look for key words in the project issue tracker.

Filter on the "beginner friendly" label for issues which are good for new contributors.

Contributing code via pull requests

While issue reporting is valuable, we strongly encourage users who are inclined to do so to submit patches for new or existing issues via pull requests. This is particularly the case for simple fixes, such as typos or tweaks to documentation, which do not require a heavy investment of time and attention.

Contributors are also encouraged to contribute new code to enhance PyMC's functionality, also via pull requests. Please consult the PyMC documentation to ensure that any new contribution does not strongly overlap with existing functionality.

The preferred workflow for contributing to PyMC is to fork the GitHub repository, clone it to your local machine, and develop on a feature branch.

Steps:

  1. Fork the project repository by clicking on the 'Fork' button near the top right of the main repository page. This creates a copy of the code under your GitHub user account.

  2. Clone your fork of the PyMC repo from your GitHub account to your local disk, and add the base repository as a remote:

    $ git clone git@github.com:<your GitHub handle>/pymc.git
$ cd pymc
$ git remote add upstream git@github.com:pymc-devs/pymc.git

  3. Create a feature branch to hold your development changes:

    $ git checkout -b my-feature

    Always use a feature branch. It's good practice to never routinely work on the main branch of any repository.

  4. Project requirements are in requirements.txt, and libraries used for development are in requirements-dev.txt. The easiest (and recommended) way to set up a development environment is via miniconda:

    $ conda env create -f conda-envs/environment-dev-py37.yml  # or py38 or py39
$ conda activate pymc-dev-py37
$ pip install -e .

    Alternatively you may (probably in a virtual environment) run:

    $ pip install -e .
$ pip install -r requirements-dev.txt

    Yet another alternative is to create a docker environment for development. See: Developing in Docker.

  5. Develop the feature on your feature branch. Add changed files using git add and then git commit files:

    $ git add modified_files
$ git commit

    to record your changes locally. After committing, it is a good idea to sync with the base repository in case there have been any changes:

    $ git fetch upstream
$ git rebase upstream/main

    Then push the changes to your GitHub account with:

    $ git push -u origin my-feature

  6. Go to the GitHub web page of your fork of the PyMC repo. Click the 'Pull request' button to send your changes to the project's maintainers for review. This will send an email to the committers.

Pull request checklist

We recommended that your contribution complies with the following guidelines before you submit a pull request:

  • If your pull request addresses an issue, please use the pull request title to describe the issue and mention the issue number in the pull request description. This will make sure a link back to the original issue is created.

  • All public methods must have informative docstrings with sample usage when appropriate.

  • Please prefix the title of incomplete contributions with [WIP] (to indicate a work in progress). WIPs may be useful to (1) indicate you are working on something to avoid duplicated work, (2) request broad review of functionality or API, or (3) seek collaborators.

  • All other tests pass when everything is rebuilt from scratch. See Developing in Docker for information on running the test suite locally.

  • When adding additional functionality, provide at least one example script or Jupyter Notebook in the pymc/examples/ folder. Have a look at other examples for reference. Examples should demonstrate why the new functionality is useful in practice and, if possible, compare it to other methods available in PyMC.

  • Documentation and high-coverage tests are necessary for enhancements to be accepted.

  • Run any of the pre-existing examples in docs/source/notebooks that contain analyses that would be affected by your changes to ensure that nothing breaks. This is a useful opportunity to not only check your work for bugs that might not be revealed by unit test, but also to show how your contribution improves PyMC for end users.

You can also check for common programming errors with the following tools:

  • Code with good test coverage (at least 80%), check with:

    $ pip install pytest pytest-cov coverage
$ pytest --cov=pymc pymc/tests/<name of test>.py

  • No pre-commit errors: see the Python code style and Jupyter Notebook style page from our Wiki on how to install and run it.

Developing in Docker

We have provided a Dockerfile which helps for isolating build problems, and local development. Install Docker for your operating system, clone this repo, then run ./scripts/start_container.sh. This should start a local docker container called pymc, as well as a jupyter notebook server running on port 8888. The notebook should be opened in your browser automatically (you can disable this by passing --no-browser). The repo will be running the code from your local copy of pymc, so it is good for development.

You may also use it to run the test suite, with

$  docker exec -it pymc  bash # logon to the container
$  cd ~/pymc/tests
$  . ./../../scripts/test.sh # takes a while!

This should be quite close to how the tests run on TravisCI.

If the container was started without opening the browser, you need the notebook instances token to work with the notebook. This token can be accessed with

docker exec -it pymc jupyter notebook list

Style guide

We have configured a pre-commit hook that checks for black-compliant code style. We encourage you to configure the pre-commit hook as described in the PyMC Python Code Style Wiki Page, because it will automatically enforce the code style on your commits.

Similarly, consult the PyMC's Jupyter Notebook Style guides for notebooks.

For documentation strings, we prefer numpy style to comply with the style that predominates in our upstream dependencies.

This guide was derived from the scikit-learn guide to contributing