Contribute to SF¶

How to contribute to Sample Factory?¶

Sample Factory is an open source project, so all contributions and suggestions are welcome.

You can contribute in many different ways: giving ideas, answering questions, reporting bugs, proposing enhancements, improving the documentation, fixing bugs.

Huge thanks in advance to every contributor!

How to work on an open Issue?¶

You have the list of open Issues at: https://github.com/alex-petrenko/sample-factory/issues

Some of them may have the label help wanted: that means that any contributor is welcomed!

If you would like to work on any of the open Issues:

Make sure it is not already assigned to someone else. You have the assignee (if any) on the top of the right column of the Issue page.
You can self-assign it by commenting on the Issue page with one of the keywords: #take or #self-assign.
Work on your self-assigned issue and eventually create a Pull Request.

How to create a Pull Request?¶

Fork the repository by clicking on the 'Fork' button on the repository's page. This creates a copy of the code under your GitHub user account.

Clone your fork to your local disk, and add the base repository as a remote:

git clone git@github.com:<your Github handle>/sample-factory.git
cd sample-factory
git remote add upstream https://github.com/alex-petrenko/sample-factory.git

Create a new branch to hold your development changes:
```
git checkout -b a-descriptive-name-for-my-changes
```
do not work on the main branch.
Set up a development environment by running the following command in a virtual (or conda) environment:
```
pip install -e .[dev]
```

(If sample-factory was already installed in the virtual environment, remove it with pip uninstall sample-factory before reinstalling it in editable mode with the -e flag.)

Develop the features on your branch.
Format your code. Run black and isort so that your newly added files look nice with the following command:
```
make format
```
If you want to enable auto format checking before every commit, you can run the following command:
```
pre-commit install
```

(Optional) to update pre-commit hooks, run the following command:

pre-commit autoupdate

Run unittests with the following command:
```
make test
```
Once you're happy with your files, add your changes and make a commit to record your changes locally:
```
git add sample-factory/<your_dataset_name>
git commit
```
It is a good idea to sync your copy of the code with the original repository regularly. This way you can quickly account for changes:
```
git fetch upstream
git rebase upstream/main
```

Push the changes to your account using:

git push -u origin a-descriptive-name-for-my-changes

Once you are satisfied, go the webpage of your fork on GitHub. Click on "Pull request" to send your to the project maintainers for review.

See also additional notes on how to contribute to the documentation website.