Skip to content

HowToFilePR

Winlin edited this page Dec 24, 2021 · 37 revisions

HOME > HowToFilePR

HowToFilePR

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.
  • Don't close PR when update, only update the branch bugfix/bug-summary, very simple.
  • Be focus, one PR fixes exactly one bug/feature, without any noise like space or dead codes.

File New PR

The workflow to patch 4.0release or any other branches:

Step 1: Fork SRS

Open ossrs/srs, click Fork to your repository.

Step 2: Clone your repository

git clone git@github.com:your-account/srs.git
git checkout -b master origin/master

Note: You should setup your git user.name and user.email.

Step 3: Add a remote srs

git remote add srs https://github.com/ossrs/srs.git
git fetch srs

Step 4: Sync with remote before each PR

git fetch --all

Step 5: Checkout a new branch from srs

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

Note: Please name your branch, by summary of bug, for example bugfix/rtc-listen-ipv6

Step 6: Update and push to your repository

git push -u origin bugfix/bug-summary

Step 7: File a PR from your bugfix/bug-summary to SRS 4.0release

Update Your PR

After review, you might need to update your PR:

git checkout bugfix/bug-summary
git commit -am 'Description for update'
git push

Note: Don't file a new PR, what you need to do is to commit to your branch, the PR will be updated automatically by GitHub.

Welcome to SRS wiki!

SRS 5.0 wiki

Please select your language:

SRS 4.0 wiki

Please select your language:

SRS 3.0 wiki

Please select your language:

SRS 2.0 wiki

Please select your language:

SRS 1.0 wiki

Please select your language:

Clone this wiki locally