summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorOpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com>2021-05-29 03:48:30 +0200
committerGitHub <noreply@github.com>2021-05-29 03:48:30 +0200
commit083746112f80b4a6164c1fdcdef54da155cfb855 (patch)
treeaead575912ec96f6e6ba02e35b994dcc21996821 /CONTRIBUTING.md
parent3d6c19c8be696e491fc215e334e38f638e55da2d (diff)
parent6deb1bc2aea34320fd0b463257332cfa06475aa1 (diff)
downloadpodman-083746112f80b4a6164c1fdcdef54da155cfb855.tar.gz
podman-083746112f80b4a6164c1fdcdef54da155cfb855.tar.bz2
podman-083746112f80b4a6164c1fdcdef54da155cfb855.zip
Merge pull request #10477 from Procyhon/manpage_syntax
[CI:DOCS] Manpage syntax proposal
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index cb8bce9ed..cbe0fcfab 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -126,6 +126,10 @@ Well, you can now create your own branch, apply changes on it, and then submitti
For further reading about branching [you can read this document](https://herve.beraud.io/containers/linux/podman/isolate/environment/2019/02/06/how-to-hack-on-podman.html).
+## Documentation
+
+Make sure to update the documentation if needed. You can find the man pages under `docs/source/markdown`. The syntax for the formatting of all man pages can be found [here](docs/MANPAGE_SYNTAX.md).
+
## Submitting Pull Requests
No Pull Request (PR) is too small! Typos, additional comments in the code,