Skip to content

Latest commit

 

History

History
93 lines (63 loc) · 3.12 KB

CONTRIBUTING.md

File metadata and controls

93 lines (63 loc) · 3.12 KB
Raw

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,...

Many 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:

  1. 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.

  2. You can self-assign it by commenting on the Issue page with one of the keywords: #take or #self-assign.

  3. Work on your self-assigned issue and eventually create a Pull Request.

How to create a Pull Request?

  1. 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.

  2. 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

  3. 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.

  4. Set up a development environment by running the following command in a virtual 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.)

  5. This repo uses black, isort and flake8 to enforce code format and style. If you wanna automatically check and correct your code format everytime you commit, run the following commands:

    pre-commit install

  6. Develop the features on your branch.

  7. Format your code. Run black and isort so that your newly added files look nice with the following command:

    make format
make check-codestyle

(make check-codestyle should yield no errors)

  1. Run unittests with the following command:

    make test

  2. 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

  3. 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.