Skip to content

Latest commit

 

History

History
92 lines (56 loc) · 3.04 KB

CONTRIBUTING.md

File metadata and controls

92 lines (56 loc) · 3.04 KB
Raw

How to contribute to the dataset viewer?

Contributor Covenant

The dataset viewer 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.

In order to facilitate healthy, constructive behavior in an open and inclusive community, we all respect and abide by our code of conduct.

How to work on an open Issue?

You have the list of open Issues at: https://github.com/huggingface/datasets/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 [email protected]:<your Github handle>/dataset-viewer.git
cd dataset-viewer
git remote add upstream https://github.com/huggingface/dataset-viewer.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 following the developer guide

  5. Develop the features on your branch.

  6. Format your code. Run the linter and formatter, so that your newly added files look nice with the following command:

    make style

  7. Once you're happy with your code, add your changes and make a commit to record your changes locally:

    git add -p
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

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

Thank you for your contribution!

Python docstrings

This projects follows HuggingFace docstring guidelines.

Code of conduct

This project adheres to the HuggingFace code of conduct. By participating, you are expected to uphold this code.