Skip to content

Mention no images added to repository #14738

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 13, 2021
Merged

Mention no images added to repository #14738

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1c83659
Mention no images added to repository
LysandreJik Dec 13, 2021
997e74f
Update CONTRIBUTING.md
LysandreJik Dec 13, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -275,6 +275,9 @@ Follow these steps to start contributing:
CircleCI does not run the slow tests, but github actions does every night!
6. All public methods must have informative docstrings that work nicely with sphinx. See `modeling_bert.py` for an
example.
7. Due to the rapidly growing repository, it is important to make sure that no files that would significantly weigh down the repository are added. This includes images, videos and other non-text files. We prefer to leverage a hf.co hosted `dataset` like
the ones hosted on [`hf-internal-testing`](https://huggingface.co/hf-internal-testing) in which to place these files and reference
Copy link
Contributor

@NielsRogge NielsRogge Dec 13, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FYI the repo I use for documentation images is called "documentation-images": https://huggingface.co/datasets/huggingface/documentation-images

them by URL.

See more about the checks run on a pull request in our [PR guide](pr_checks)

Expand Down