Contributing

Important

Do not edit README.md, as it is automatically created from the about and contributing pages!

To contribute, first download the CIS Benchmarks and find a section you would like to help summarize. (See our examples for more info.)

Then, install the required python dependencies.

Windows:

py -3 -m pip install --upgrade sphinx myst_parser pygments

Mac/Linux:

python3 -m pip install --upgrade sphinx myst_parser pygments

Then, clone the git repository and add your contributions to /source. Add your contributions to /source/index.rst to make sure they appear on the website.

To build your changes, run sphinx-build source docs.

Then open a pull request to publish your changes! Please do not commit the /docs folder, as github actions is set to automatically build sphinx. Any help on this project is greatly appreciated!