yujunjun/datahub
2
0
Fork 0
mirror of https://github.com/datahub-project/datahub.git synced 2025-07-19 15:42:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md

Browse Source
This commit is contained in:
Mars Lan 2020-02-18 11:24:29 -08:00 committed by GitHub
parent ba6029bbd1
commit eb5c84a7c6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 54 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
CONTRIBUTING.md
View File

@ -19,60 +19,8 @@ If you find a bug:
Before you submit your Pull Request (PR), consider the following guidelines:
* Search GitHub for an open or closed PR that relates to your submission. You don't want to duplicate effort.
* Make your changes in a new branch:
```
git checkout -b my-fix-branch master
```
* Create your patch, *including appropriate test cases*.
* Run the test suite
* Commit your changes using a descriptive commit message that follows our [commit message format](#commit-message-format).
```
git commit -a
```
Note: The optional commit -a command-line option will automatically "add" and "rm" edited files.
* Push your branch to GitHub:
git push origin my-fix-branch
* In GitHub, send a pull request to `datahub:master`
* If we suggest changes, then:
* Make the required updates.
* Re-run the test suite
* Rebase your branch and force push to your GitHub repository (this will update your Pull Request)
```
git rebase master -i
git push -f
```
That's it! Thank you for your contribution!
## After your pull request is merged
After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository:
* Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:
```
git push origin --delete my-fix-branch
```
* Check out the master branch:
```
git checkout master -f
```
* Update your master with the latest upstream version:
```
git pull --ff upstream master
```
* Follow the [standard GitHub approach](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork) to create the PR. Please follow our [commit message format](#commit-message-format).
* That's it! Thank you for your contribution!
## Commit Message Format