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

Merge pull request #1784 from dclim/documentation-fixes 

Minor documentation fixes for CONTRIBUTING.md
This commit is contained in:
Charles Allen 2015-09-29 11:53:35 -07:00
parent ff5e3b7e7d a58df303be
commit eb48a9eb81
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
CONTRIBUTING.md
View File

@ -7,12 +7,12 @@ When submitting a pull request (PR), please use the following guidelines:
- Keep the number of commits small and combine commits for related changes. - Keep the number of commits small and combine commits for related changes.
Each commit should compile on its own and ideally pass tests. Each commit should compile on its own and ideally pass tests.
- If you are introducing a new feature you may want to first submit your idea - If you are introducing a new feature you may want to first submit your idea
of feedback in the [mailing list](mailto:druid-development@googlegroups.com). for feedback to the [mailing list](mailto:druid-development@googlegroups.com).
- Bugfixes should include a unit-test or integration test reproducing the issue. - Bugfixes should include a unit test or integration test reproducing the issue.
- Non-trivial features should include unit-test covering the new functionality. - Non-trivial features should include unit tests covering the new functionality.
- Make sure your code respects existing formatting conventions. We don't have a - Make sure your code respects existing formatting conventions. We don't have a
formal style guide yet, but use your own judgement. If you are using formal style guide yet, but use your own judgement. If you are using
IntelliJ, you can use import our code style settings jar IntelliJ, you can import our code style settings jar:
[intellij_formatting.jar](https://github.com/druid-io/druid/raw/master/intellij_formatting.jar). [intellij_formatting.jar](https://github.com/druid-io/druid/raw/master/intellij_formatting.jar).
- Keep formatting changes in separate commits to make code reviews easier and - Keep formatting changes in separate commits to make code reviews easier and
distinguish them from actual code changes. distinguish them from actual code changes.
@ -114,9 +114,9 @@ When submitting a pull request (PR), please use the following guidelines:
# FAQ # FAQ
### Help! I merged changes from upstream and cannot figure out how to resolve conflits when rebasing! ### Help! I merged changes from upstream and cannot figure out how to resolve conflicts when rebasing!
Never fear, if you occasionally merged upgstream/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`
@ -137,7 +137,7 @@ Never fear, if you occasionally merged upgstream/master, here is another way to
git commit git commit
``` ```
1. You can now submit this new branch and create or replace your existing pull request 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