Apache
/
druid
mirror of https://github.com/apache/druid.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix numbered list formatting in markdown. (#9664)

This commit is contained in:
Abhishek Radhakrishnan 2020-04-21 20:18:12 -07:00 committed by GitHub
parent 68cc0b2e1c
commit 8abcbf671d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 23 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
CONTRIBUTING.md
View File

@ -48,7 +48,7 @@ You can find more developers' resources in [`dev/`](dev) directory.
https://github.com/apache/druid/fork https://github.com/apache/druid/fork
1. Clone your fork of the GitHub repository 2. Clone your fork of the GitHub repository
```sh ```sh
git clone git@github.com:<username>/druid.git git clone git@github.com:<username>/druid.git
@ -56,7 +56,7 @@ You can find more developers' resources in [`dev/`](dev) directory.
replace `<username>` with your GitHub username. replace `<username>` with your GitHub username.
1. Add a remote to keep up with upstream changes 3. Add a remote to keep up with upstream changes
``` ```
git remote add upstream https://github.com/apache/druid.git git remote add upstream https://github.com/apache/druid.git
@ -68,20 +68,20 @@ You can find more developers' resources in [`dev/`](dev) directory.
git fetch upstream master git fetch upstream master
``` ```
1. Create a feature branch to work in 4. Create a feature branch to work in
``` ```
git checkout -b feature-xxx remotes/upstream/master git checkout -b feature-xxx remotes/upstream/master
``` ```
1. _Before submitting a pull request_ periodically rebase your changes 5. _Before submitting a pull request_ periodically rebase your changes
(but don't do it when a pull request is already submitted) (but don't do it when a pull request is already submitted)
``` ```
git pull --rebase upstream master git pull --rebase upstream master
``` ```
1. Before submitting a pull request, combine ("squash") related commits into a single one 6. Before submitting a pull request, combine ("squash") related commits into a single one
``` ```
git rebase -i upstream/master git rebase -i upstream/master
@ -91,7 +91,7 @@ You can find more developers' resources in [`dev/`](dev) directory.
- Re-order the lines to change commit order (to the extent possible without creating conflicts) - Re-order the lines to change commit order (to the extent possible without creating conflicts)
- Prefix commits using `s` (squash) or `f` (fixup) to merge extraneous commits. - Prefix commits using `s` (squash) or `f` (fixup) to merge extraneous commits.
1. Submit a pull-request 7. Submit a pull-request
``` ```
git push origin feature-xxx git push origin feature-xxx
@ -111,7 +111,7 @@ You can find more developers' resources in [`dev/`](dev) directory.
- Give your pull-request a meaningful title. - Give your pull-request a meaningful title.
- In the description, explain your changes and the problem they are solving. - In the description, explain your changes and the problem they are solving.
1. Addressing code review comments 8. Addressing code review comments
Address code review comments by committing changes and pushing them to your feature Address code review comments by committing changes and pushing them to your feature
branch. branch.
@ -146,26 +146,25 @@ You can find more developers' resources in [`dev/`](dev) directory.
Never fear! If you occasionally merged upstream/master, here is another way to squash your changes into a single commit: Never fear! If you occasionally merged upstream/master, here is another way to squash your changes into a single commit:
1. First, rename your existing branch to something else, e.g. `feature-xxx-unclean` 1. First, rename your existing branch to something else, e.g. `feature-xxx-unclean`
```
git branch -m feature-xxx-unclean
```
``` 2. Checkout a new branch with the original name `feature-xxx` from upstream. This branch will supercede our old one.
git branch -m feature-xxx-unclean
```
1. Checkout a new branch with the original name `feature-xxx` from upstream. This branch will supercede our old one. ```
git checkout -b feature-xxx upstream/master
```
``` 3. Then merge your changes in your original feature branch `feature-xxx-unclean` and create a single commit.
git checkout -b feature-xxx upstream/master
```
1. Then merge your changes in your original feature branch `feature-xxx-unclean` and create a single commit. ```
git merge --squash feature-xxx-unclean
git commit
```
``` 4. You can now submit this new branch and create or replace your existing pull request.
git merge --squash feature-xxx-unclean
git commit
```
1. You can now submit this new branch and create or replace your existing pull request. ```
git push origin [--force] feature-xxx:feature-xxx
``` ```
git push origin [--force] feature-xxx:feature-xxx
```