Skip to content

Commit a457c8b

Browse files
Clarify PR process and remove irrelevant boilerplate
1 parent b026391 commit a457c8b

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,18 @@ Please note we have a code of conduct, please follow it in all your interactions
99

1010
1. Ensure any install or build dependencies are removed before the end of the layer when doing a
1111
build.
12-
2. Update the README.md with details of changes to the interface, this includes new environment
13-
variables, exposed ports, useful file locations and container parameters.
14-
3. Increase the version numbers in any examples files and the README.md to the new version that this
15-
Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
16-
4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you
17-
do not have permission to do that, you may request the second reviewer to merge it for you.
12+
2. Install the [pre-commit hooks](markdown/precommit.md) and `.editorconfig`
13+
[extension](https://editorconfig.org/#download) to keep formatting and linting consistent across
14+
the repo's code base.
15+
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.
17+
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.
21+
6. You may merge the Pull Request in once you have the sign-off of the repo maintainer.
22+
If you do not have permission to do that, you may request the reviewer to merge
23+
it for you.
1824

1925
## Code of Conduct
2026

0 commit comments

Comments
 (0)