Skip to content

Commit

Permalink
Add section in CONTRIBUTING.md on docs changes.
Browse files Browse the repository at this point in the history
Signed-off-by: Felix Fontein <felix@fontein.de>
  • Loading branch information
felixfontein committed Sep 16, 2023
1 parent 51851ed commit 784041b
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,11 @@ and instructions if you are thinking of helping with the development of SOPS.
how to install Go [here](https://go.dev/doc/install)
- Clone the Git repository and switch into SOPS's directory.
- Run the tests with `make test`. They should all pass.
- If you modify documentation (RST or MD files), run `make checkdocs` to run
[rstcheck](https://pypi.org/project/rstcheck/) and
[markdownlint](https://github.com/markdownlint/markdownlint). These should also
pass. If you need help in fixing issues, create a pull request (see below) and
ask for help.
- Fork the project on GitHub.
- Add your fork to Git's remotes:
- If you use SSH authentication:
Expand Down

0 comments on commit 784041b

Please sign in to comment.