First of all Create a GitHub account (a free one is enough) by following these steps.
Our workflow is like this:
Open a Discussion (for ideas and proposals) If your proposal qualifies for the MASTG/MASVS we'll convert it into an "Issue" (the discussion might take a while).
MASVS Example: "Add a MASVS-CRYPTO requirement on Key rotation"
MASTG Example: "Add a Test case for key rotation"
Open an Issue (for concrete actionable things that have to / could be done) For instance, there's a typo, or it's clear that a certain Test case doesn't have e.g. "Dynamic Analysis" and it should be added.
- Open a PR (to add actual content) This could be the fix for the mentioned typo, a whole new section or some other content. Usually a PR has a "closes" sentence in its description. For example "Closes #543" so that we (and GitHub) know which Issue(s) is being addressed on that PR.
Normally, contributors should follow the whole flow. But sometimes it's clear what's needed so we directly go to 2 (open an issue) or even to 3 (open a PR). We recommend starting with a discussion or directly contacting us to save you the hurdle of writing and submitting new content that does not qualify so we have to reject it after the work is done.
If you just have an specific question you can post it to (you need a GitHub Account):
"GitHub Discussions" are re-posted to our Slack channel.
Once you get your answer please mark it as answered. When you mark a question as an answer, GitHub will highlight the comment and replies to the comment to help visitors quickly find the answer.
GitHub makes this extremely easy.
For small changes in one file:
- Go to the file you'd like to modify and click on "Edit".
- Do your changes and commit them. GitHub will guide you and suggest to open a Pull Request.
For more complex changes or across files:
.while browsing the repo or pull request.
- You'll be welcomed with a "github.dev Web-based Editor" where you can work using an online Visual Studio.
- Do your changes, commit and push them as you'd do locally.
Learn more about the github.dev Web-based Editor in "GitHub Docs".
For this you need an IDE or text editor and git on your machine. We recommend using the free Visual Studio Code editor with the markdownlint extension.
- Fork the repo. Forking the repo allows you to make your changes without affecting the original project until you're ready to merge them.
- Clone your fork repo and add the remote upstream repo, e.g. for owasp-masvs:
$ git clone https://github.com/<your_github_user>/owasp-masvs.git $ cd owasp-masvs/ $ git remote add upstream [email protected]:OWASP/owasp-masvs.git
- Create a branch.
$ git checkout -b fix-issue-1456
- Make your changes.
- Commit and push your changes. This can be done by executing the command
git add MYFILEfor every file you have modified, followed by
git commit -m 'Your Commit Message'to commit the modifications and
git pushto push your modifications to GitHub.
- Open a PR.