Skip to content

Commit 4ab4688

Browse files
Update CONTRIBUTING.md
Oxford comma && nomenclature
1 parent 479596a commit 4ab4688

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,13 @@ Please note we have a code of conduct, please follow it in all your interactions
1313
[extension](https://editorconfig.org/#download) to keep formatting and linting consistent across
1414
the repo's code base.
1515
3. Create a new `<name_of_topic>.md` under the `markdown` directory in place of a traditional
16-
`README.md`. Note the lowercase [snake_case](https://betterprogramming.pub/string-case-styles-camel-pascal-snake-and-kebab-case-981407998841) style formatting.
16+
`README.md`. Note the lowercase
17+
[snake_case](https://betterprogramming.pub/string-case-styles-camel-pascal-snake-and-kebab-case-981407998841)
18+
style formatting.
1719
4. Update the `<name_of_topic>.md` with details of changes to the interface, this includes new
18-
environment variables, exposed ports, useful file locations and container parameters.
19-
5. Any relevant images should be stored in the top-level `img` directory and embedded within
20-
the `<name_of_topic>.md` document.
20+
environment variables, exposed ports, useful file locations, and container parameters.
21+
5. Any relevant images should be stored in the top-level `img` directory, `<snake_case_style>.png`,
22+
and embedded within the `<name_of_topic>.md` document.
2123
6. You may merge the Pull Request in once you have the sign-off of the repo maintainer.
2224
If you do not have permission to do that, you may request the reviewer to merge
2325
it for you.

0 commit comments

Comments
 (0)