Mention no images added to repository #14738
Merged
+3
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
NielsRogge
reviewed
Dec 13, 2021
NielsRogge
reviewed
Dec 13, 2021
| @@ -275,6 +275,10 @@ 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 file 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 | |||
There was a problem hiding this comment.
FYI the repo I use for documentation images is called "documentation-images": https://huggingface.co/datasets/huggingface/documentation-images
sgugger
approved these changes
Dec 13, 2021
Co-authored-by: NielsRogge <[email protected]>
|
WIll merge this as a first step! |
|
Merged too soon? We need a concrete destination for images that we all share. |
|
but it's not part of this PR that was merged. i.e. @NielsRogge's suggestion wasn't integrated into the doc. additionally please please keep these instructions in |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Mention that images shouldn't be added to the repository as it will otherwise significantly weigh down the repository.