Skip to content

Latest commit

 

History

History
156 lines (115 loc) · 5.5 KB

contributing.md

File metadata and controls

156 lines (115 loc) · 5.5 KB

How can I contribute?

GPJax welcomes contributions from interested individuals or groups. There are many ways to contibute, including:

Code of conduct

As a contributor to GPJax, you can help us keep the community open and inclusive. Please read and follow our Code of Conduct.

Opening issues and getting support

Please open issues on Github Issue Tracker. Here you can mention

You can ask a question or start a discussion in the Discussion section on Github.

Contributing to the source code

Submitting code contributions to GPJax is done via a GitHub pull request. Our preferred workflow is to first fork the GitHub repository, clone it to your local machine, and develop on a feature branch. Once you're happy with your changes, install our pre-commit hooks, commit and push your code.

New to this? Don't panic, our guide below will walk you through every detail!

:::{attention} Before opening a pull request we recommend you check our pull request checklist.

Step-by-step guide:

  1. Click here to Fork GPJax's codebase (alternatively, click the 'Fork' button towards the top right of the main repository page). This adds a copy of the codebase to your GitHub user account.

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

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

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

    $ git checkout -b my-feature

    :::{attention} Always use a feature branch. It's good practice to avoid work on the main branch of any repository.

  4. Project requirements are in requirements.txt. We suggest using a virtual environment for development. Once the virtual environment is activated, run:

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

  5. Install the pre-commit hooks.

    $ pre-commit install

    :::{warning} Please ensure you have done this before commiting any files. If successful, this will print the following output pre-commit installed at .git/hooks/pre-commit.

  6. Add changed files using git add and then git commit files to record your changes locally:

    $ git add modified_files
$ git commit

    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

  7. Go to the GitHub web page of your fork of the GPJax repo. Click the 'Pull request' button to send your changes to the project's maintainers for review.

Pull request checklist

We welcome both complete or "work in progress" pull requests. Before opening one, we recommended you check the following guidelines to ensure a smooth review process.

My contribution is a "work in progress":

Please prefix the title of incomplete contributions with [WIP] (to indicate a work in progress). WIPs are useful to:

  1. Indicate you are working on something to avoid duplicated work.
  2. Request broad review of functionality or API.
  3. Seek collaborators.

In the description of the pull request, we recommend you outline where work needs doing. For example, do some tests need writing?

My contribution is complete:

If addressing 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. Then before making your pull request, we recommend you check the following:

  • Do all public methods have informative docstrings that describe their function, input(s) and output(s)?

  • Do the tests pass when everything is rebuilt from scratch?

  • Documentation and high-coverage tests are necessary for enhancements to be accepted. Test coverage can be checked with:

    $ pip install -r requirements-dev.txt
$ pytest tests --cov=./ --cov-report=html

Navigate to the newly created folder htmlcov and open index.html to view the coverage report.

This guide was derived from PyMC's guide to contributing.