Skip to content

Commit 233ed5a

Browse files
authored
Merge pull request #9080 from microsoft/ntrogh-patch-1
Update contribution guidelines for docs images
2 parents aef9972 + 40243b3 commit 233ed5a

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -225,11 +225,16 @@ Note the subheading title is lowercase and subheading title words are separated
225225

226226
Images are important to bring the product to life and clarify the written content.
227227

228-
For images you're adding to the repo, store them in the `images` subfolder of the TOC section, for example: `editor\images\debugging`.
228+
* Store images for an article in the `docs/<section>/images/<article name>` subfolder. For example: `docs/sourcecontrol/images/overview`.
229229

230-
When you link to an image, the path and filename are case-sensitive. The convention is for image filenames to be all lowercase and use dashes `-` for separators.
230+
* Image filenames should use all lowercase and use dashes (`-`) as word separator. For example: `![Debug Breakpoints](images/debugging/breakpoints-view.png)`
231231

232-
>For example: `![Debug Breakpoints](images/debugging/breakpoints-view.png)`
232+
* Link to an image using relative path names, the path and filename are case-sensitive.
233+
234+
* Images are cached on the server for indeterminate time, so don't update images in-place. Create a new file and add a version indicator (yyyymmddseq) to the image filename.
235+
236+
> [!IMPORTANT]
237+
> Make sure you have Git LFS enabled on your machine!
233238
234239
### Key bindings
235240

0 commit comments

Comments
 (0)