入门¶
首先,免费创建一个 GitHub 账号。
在线贡献¶
GitHub 使这变得非常容易。
对于单个文件中的小改动
- 转到您想要修改的文件,然后点击“编辑”。
- 进行更改并提交。 GitHub 将引导您并建议打开一个 Pull Request(拉取请求)。
对于更复杂的更改或跨文件更改
- 在浏览仓库或拉取请求时,按下
.
。 - 您将看到一个 “基于 Web 的 github.dev 编辑器”,您可以在其中使用在线 Visual Studio 进行工作。
- 像在本地一样,进行更改、提交并推送它们。
在 “GitHub 文档”中了解有关基于 Web 的 github.dev 编辑器的更多信息。
最后,系统将提示您打开一个拉取请求 (PR)。 打开 PR 时,请遵循 PR 指南,并获取您的拉取请求的审查。
离线贡献¶
为此,您需要在机器上安装 IDE 或文本编辑器以及 git。 我们建议使用免费的 Visual Studio Code 编辑器和 markdownlint 扩展。
- Fork(派生)仓库。 Fork 仓库允许您进行更改,而不会影响原始项目,直到您准备好合并它们。
-
克隆您的 fork 仓库,并添加远程上游仓库,例如对于 OWASP MASTG
$ git clone https://github.com/<your_github_user>/mastg.git $ cd mastg/ $ git remote add upstream [email protected]:OWASP/mastg.git
-
创建一个分支。
$ git checkout -b fix-issue-1456
-
进行更改。
- 提交并推送您的更改。 这可以通过为每个修改过的文件执行命令
git add MYFILE
来完成,然后执行git commit -m 'Your Commit Message'
来提交修改,并执行git push
将修改推送到 GitHub。 - 打开一个 PR.
- 获得您的 PR 审查.