Contributing to the MSTG can be done in many different ways:
In order to increase the chances of your PR being accepted, please make sure that:
After your PR has been submitted, we will review it as quickly as possible. This typically only takes a few days, but can vary depending on the size of the PR. Small PRs require only one reviewer, while large PRs may require multiple reviewers. We will always try to give initial feedback on your PR within 14 days. If you think we have forgotten about your PR, feel free to give us a nudge after these 7 days have passed.
Create a GitHub account. Multiple different GitHub subscription plans are available, but you only need a free one. Follow these steps to set up your account.
Fork the repository. Creating a fork means creating a copy of the repository on your own account, which you can modify without any impact on this repository. GitHub has an article that describes all the needed steps.
Clone your own repository to your machine so that you can make modifications. If you followed the GitHub tutorial from step 2, you have already done this.
Go to the newly cloned directory "owasp-mstg" and add the remote upstream repository:
$ git remote -v
origin git@github.com:<your Github handle>/owasp-mstg.git (fetch)
origin git@github.com:<your Github handle>/owasp-mstg.git (push)
$ git remote add upstream git@github.com:OWASP/owasp-mstg.git
$ git remote -v
origin git@github.com:<your Github handle>/owasp-mstg.git (fetch)
origin git@github.com:<your Github handle>/owasp-mstg.git (push)
upstream git@github.com:OWASP/owasp-mstg.git (fetch)
upstream git@github.com:OWASP/owasp-mstg.git (push)
See also the GitHub documentation on "Configuring a remote for a fork".
Choose what to work on, based on any of the outstanding issues.
Create a branch so that you can cleanly work on the chosen issue: git checkout -b FixingIssue66
Open your favorite editor and start making modifications. We recommend using the free Visual Studio Code editor as it can make use of the code linting that is part of the repository through the MarkdownLint plugin. The code linter can help you when you make mistakes against our style guide, but be sure to read the style guide yourself, as the code linter will only detect a part of it.
After your modifications are done, push them to your forked repository. This can be done by executing the command git add MYFILE
for every file you have modified, followed by git commit -m 'Your Commit Message'
to commit the modifications and git push
to push your modifications to GitHub.
Create a Pull Request (PR) by going to your fork, https://github.com/Your_Github_Handle/owasp-mstg and click on the "New Pull Request" button. The target branch should typically be the Master branch. When submitting a PR, be sure to follow the checklist that is provided in the PR template. The checklist itself will be filled out by the reviewer.
Your PR will be reviewed and comments may be given. In order to process a comment, simply make modifications to the same branch as before and push them to your repository. GitHub will automatically detect these changes and add them to your existing PR.
When starting on a new PR in the future, make sure to always keep your local repo up to date:
$ git fetch upstream
$ git merge upstream/master
See also the following article for further explanation on "How to Keep a Downstream git Repository Current with Upstream Repository Changes".
If at any time you want to work on a different issue, you can simply switch to a different branch, as explained in step 5.
Tip: Don't try to work on too many issues at once though, as it will be a lot more difficult to merge branches the longer they are open.
Our current goal is to publish one minor release every 6 months. Next, we will often create patch updates in order to provide intermediary updates in PDF and DocX format. Releases that have been tagged can then be translated into preferred languages.
Note we use semantic versioning: major.minor.patch
Although we greatly appreciate any and all contributions to the project, there are a few things that you should take into consideration:
Please be sure to take a careful look at our Code of Conduct for all the details.
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。