Skip to content

Commit

Permalink
Refine contribute.
Browse files Browse the repository at this point in the history
  • Loading branch information
winlinvip committed Jul 28, 2023
1 parent 9a877f0 commit 5a7a65a
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
8 changes: 4 additions & 4 deletions i18n/zh-cn/docusaurus-plugin-content-pages/how-to-file-pr.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@

## Rules

* 请不要使用你的`4.0release``develop`分支,请使用`bugfix/bug-summary`,每个PR一个独立的分支。
* 请不要使用你的`develop`分支,请使用`bugfix/bug-summary`,每个PR一个独立的分支。
* 若需要更新PR,请不要关闭之前的PR,不必新开PR,只需要提交到你自己的`bugfix/bug-summary`分支,PR会自动更新。
* 请不要夹带无关的代码,一个PR解决一个问题,或者支持一个功能,请不要夹带其他的有干扰的代码。
* 请花时间学习[Pro Git](https://git-scm.com/book/en/v2),掌握GIT是非常必要的能力。

## File New PR

下图是提交到`4.0release`或其他分支的工作流:
下图是提交到`develop`或其他分支的工作流:

[![Workflow](/img/HowToFilePR.png)](https://www.figma.com/file/5yAeoq2r3wwrXZwq1f93UH/How-to-File-PR-to-SRS)

Expand Down Expand Up @@ -45,7 +45,7 @@ git fetch --all
**Step 5:** 为PR创建一个新的分支

```
git checkout -b bugfix/bug-summary srs/4.0release
git checkout -b bugfix/bug-summary srs/develop
```

> Note: 请认真给你的分支起一个名字,例如`bugfix/rtc-listen-ipv6`
Expand All @@ -58,7 +58,7 @@ git push -u origin bugfix/bug-summary

> Note: 请在代码、注释和Commit中使用英文,请不要使用其他语言,也不要使用中文。
**Step 7:** 点击[这个链接](https://github.com/ossrs/srs/compare),选择你的分支`bugfix/bug-summary`,提交到SRS的`4.0release`分支
**Step 7:** 点击[这个链接](https://github.com/ossrs/srs/compare),选择你的分支`bugfix/bug-summary`,提交到SRS的`develop`分支

> Remark: 请确保勾选上了`Allow edits and access to secrets by maintainers`,这样我们可以更新你的PR。
Expand Down
8 changes: 4 additions & 4 deletions src/pages/how-to-file-pr.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ Thank you for your PR, please follow this guide.

## Rules

* Never use your `4.0release` or `develop` branch, use `bugfix/bug-summary` for each PR.
* Never use your `develop` branch, use `bugfix/bug-summary` for each PR.
* Don't close PR when update, only update the branch `bugfix/bug-summary`, simple enough.
* Be focus, one PR fixes exactly one bug/feature, without any noise like space or dead codes.
* Please study [Pro Git](https://git-scm.com/book/en/v2), it's a very important and basic skill for open-source developer.

## File New PR

The workflow to patch `4.0release` or any other branches:
The workflow to patch `develop` or any other branches:

[![Workflow](/img/HowToFilePR.png)](https://www.figma.com/file/5yAeoq2r3wwrXZwq1f93UH/How-to-File-PR-to-SRS)

Expand Down Expand Up @@ -45,7 +45,7 @@ git fetch --all
**Step 5:** Checkout a new branch from srs

```
git checkout -b bugfix/bug-summary srs/4.0release
git checkout -b bugfix/bug-summary srs/develop
```

> Note: Please name your branch, by summary of bug, for example `bugfix/rtc-listen-ipv6`
Expand All @@ -58,7 +58,7 @@ git push -u origin bugfix/bug-summary

> Note: Please use English in code, logs, commit and other text.
**Step 7:** File a [PR](https://github.com/ossrs/srs/compare) from your `bugfix/bug-summary` to SRS `4.0release`
**Step 7:** File a [PR](https://github.com/ossrs/srs/compare) from your `bugfix/bug-summary` to SRS `develop`

> Remark: Please check the `Allow edits and access to secrets by maintainers`, so we could update the PR.
Expand Down
Binary file modified static/img/HowToFilePR.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 5a7a65a

Please sign in to comment.