Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lhoestq authored Dec 17, 2024
1 parent fdda558 commit 79e360d
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,12 @@ If you want to add a dataset see specific instructions in the section [*How to a

4. Set up a development environment by running the following command in a virtual environment:

Simple setup with code formatting only (recommended)
```bash
pip install -e ".[quality]"
```

Advanced setup with all the optional dependencies
```bash
pip install -e ".[dev]"
```
Expand Down Expand Up @@ -91,14 +97,16 @@ Note that if any files were formatted by `pre-commit` hooks during committing, y

Go the webpage of your fork on GitHub. Click on "Pull request" to send your to the project maintainers for review.

## How to add a dataset
## Datasets on Hugging Face

### How to add a dataset on Hugging Face

You can share your dataset on https://huggingface.co/datasets directly using your account, see the documentation:
You can share your dataset on https://huggingface.co/datasets directly using your account (no need to open a PR on GitHub), see the documentation:

* [Create a dataset and upload files on the website](https://huggingface.co/docs/datasets/upload_dataset)
* [Advanced guide using the CLI](https://huggingface.co/docs/datasets/share)

## How to contribute to the dataset cards
### How to contribute to the dataset cards

Improving the documentation of datasets is an ever-increasing effort, and we invite users to contribute by sharing their insights with the community in the `README.md` dataset cards provided for each dataset.

Expand Down

0 comments on commit 79e360d

Please sign in to comment.