Skip to content

Commit

Permalink
Merge pull request #46 from MKhalusova/readme-update
Browse files Browse the repository at this point in the history
Updates to contribution guidelines
  • Loading branch information
MKhalusova committed Feb 27, 2024
2 parents d51b523 + ddcdb3c commit 9843ecb
Showing 1 changed file with 25 additions and 3 deletions.
28 changes: 25 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,32 @@ following qualities:

When contributing a new example/guide, open a pull request and tag [@MKhalusova](https://github.com/MKhalusova) for a review.

If using any images in the markdown, upload them to
the [huggingface/cookbook-images](https://huggingface.co/datasets/huggingface/cookbook-images) dataset. Then use the
link to the image in your markdown, e.g.:
Here are some tips:

* Make sure that your notebook's file name is in lowercase.
* Don't forget to add your notebook to the `_toctree.yml` and to `index.md`.
* Right after the notebook's first header, add yourself as an author like this: `_Authored by: [Aymeric Roucher](https://huggingface.co/m-ric)_`. You can link to your Hugging Face profile, or to your GitHub profile.
* Remove non-informative code cell outputs (e.g. from `pip install`). Make sure the notebook doesn't contain any empty code cells.
* If using any images in the markdown, upload them to the [huggingface/cookbook-images](https://huggingface.co/datasets/huggingface/cookbook-images) dataset. Then use the link to the image in your markdown, e.g.:
```![RAG diagram](https://huggingface.co/datasets/huggingface/cookbook-images/resolve/main/rag-diagram.png)```

Once your pull request is merged, the notebook will show up in the [Open-Source AI Cookbook](hf.co/learn/cookbook).

### Translating the Cookbook into your language

We'd love to have the Cookbook to be available in many more languages! Please follow the steps below if you'd like to
help translate the notebooks into your language 🙏.

If some of the notebooks have already been translated into your language, add new translated notebooks
under `notebooks/your_language`. Don't forget to add the new translated notebook to `notebooks/your_language/_toctree.yml`,
and to `notebooks/your_language/index.md`.

If the notebooks have not yet been translated to your language, create a directory under `notebooks` with your `LANG-ID`
(e.g. see `en` for English, `zh-CN` for Chinese). The `LANG-ID` should be ISO 639-1 (two lower case letters) language
code -- see [here](https://www.loc.gov/standards/iso639-2/php/code_list.php) for reference. Alternatively,
`{two lowercase letters}-{two uppercase letters}` format is also supported, e.g. `zh-CN`.

Create the `notebooks/LANG-ID/_toctree.yml`, and `notebooks/LANG-ID/index.md`, and add the translated notebook.

Finally, add your language code (the exact same `LANG-ID`) to the `build_documentation.yml` and `build_pr_documentation.yml`
files in the `.github/workflows` folder.

0 comments on commit 9843ecb

Please sign in to comment.