Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
57 lines (36 loc) · 4.08 KB

CONTRIBUTING.md

File metadata and controls

57 lines (36 loc) · 4.08 KB

Contributing to the Testing Guide

Thank you for considering contributing to the Cloud Security Testing Guide (CSTG)!

Here are some ways you can make a helpful contribution. The Open Source Guide for why and how to contribute is also a good resource. You will need a GitHub account in order to help out.

Technical Review

If you have expertise in any topic covered by the CSTG, your technical review is encouraged. Please ensure that articles:

  • Follow the article template materials
  • Follow the style guide
  • Accurately describe vulnerabilities and tests
  • Have appropriate and up-to-date inline links to resources
  • Provide complete and relevant information suitable for an audience with basic technical expertise

How to Open an Issue

Create an issue using the appropriate template.

Choose a short, descriptive title. Briefly explain what you think needs changing. Among other things, your suggestions may include grammar or spelling errors, or address insufficient or outdated content.

How to Submit a Pull Request

Here are the steps for creating and submitting a Pull Request (PR) that we can quickly review and merge.

  1. Set up your environment to fork the project and install a Markdown linter.
  2. Associate your contribution with an issue.
  3. Make your modifications. Be sure to follow our style guide.
  4. When you're ready to submit your work, push your changes to your fork. Ensure that your fork is synced with master.
  5. You can submit a draft PR or a regular PR. If your work is not yet ready for review and merge, choose a draft PR. When your changes are ready to be reviewed, you can convert to a regular PR. See how to change the stage of a PR for more.

You may want to allow edits from maintainers so we can help with small changes like fixing typos.

Once you've submitted your ready-for-review PR, we'll review it. We may comment to ask for clarification or changes, so please check back in the next few days.

To increase the chances that your PR is merged, please make sure that:

  1. You've followed the guidelines above for associating your work with an issue.
  2. Your work is Markdown linted.
  3. Your writing follows the style guide.
  4. Your code snippets are correct, well-tested, and commented where necessary for understanding.

How to Set Up Your Contributor Environment

  1. Create an account on GitHub.
  2. Install Visual Studio Code and this Markdown linter plugin. We use this linter to help keep the project content consistent and pretty.
  3. Fork and clone your own copy of the repository. Here are complete instructions for forking and syncing with GitHub.