Guidelines for Contributing

SGMCMCJax welcomes contributions from interested individuals or groups. These guidelines help explain how you can contribute to the library

There are 4 main ways of contributing to the library (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 (sgmcmcjax/examples)
Submitting issues related to bugs or desired enhancements

Opening issues and getting support

Please open issues on Github Issue Tracker.

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

Please submit patches via pull requests.

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

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.

Clone your fork of the SGMCMCJax 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>/SGMCMCJax.git
$ cd SGMCMCJax
$ git remote add upstream git@github.com:SGMCMCJax.git

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 master branch of any repository.
Project requirements are in requirements.txt, and libraries used for development are in requirements-dev.txt.

You may (probably in a virtual environment) run:
```
$ pip install -e .
$ pip install -r requirements-dev.txt
```
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
```
Go to the GitHub web page of your fork of the SGMCMCJax repo. Click the 'Pull request' button to send your changes to the project's maintainer for review.

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
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.
Documentation and high-coverage tests are necessary for enhancements to be accepted.

Code with good test, check with:

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