Repository: bookkeeper Updated Branches: refs/heads/master 164c44bb9 -> 363c5d00b
ISSUE #191: add template for ISSUE and PR Following BP-9, provide a template for ISSUE and PR. When create issue, will use ISSUE template; while create PR will use PR template. Author: jiazhai <[email protected]> Reviewers: Enrico Olivelli <[email protected]>, Sijie Guo <[email protected]> This closes #192 from jiazhai/issue_191, closes #191 Project: http://git-wip-us.apache.org/repos/asf/bookkeeper/repo Commit: http://git-wip-us.apache.org/repos/asf/bookkeeper/commit/363c5d00 Tree: http://git-wip-us.apache.org/repos/asf/bookkeeper/tree/363c5d00 Diff: http://git-wip-us.apache.org/repos/asf/bookkeeper/diff/363c5d00 Branch: refs/heads/master Commit: 363c5d00b847b7eb2a93826b6d947fd3180a37dd Parents: 164c44b Author: jiazhai <[email protected]> Authored: Wed Jun 21 10:13:17 2017 -0700 Committer: Sijie Guo <[email protected]> Committed: Wed Jun 21 10:13:17 2017 -0700 ---------------------------------------------------------------------- .github/ISSUE_TEMPLATE.md | 37 +++++++++++++++++++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 15 ++++++++++++++ pom.xml | 1 + 3 files changed, 53 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/bookkeeper/blob/363c5d00/.github/ISSUE_TEMPLATE.md ---------------------------------------------------------------------- diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..ede9c69 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,37 @@ +Is this a question, feature request, or bug report? + +**QUESTION** + +Have you checked our documentation at http://bookkeeper.apache.org/ , If you could not find an answer there, please consider asking your question in our community forum at [email protected], as it would benefit other members of our community. + + +**FEATURE REQUEST** + +1. Please describe the feature you are requesting. + +2. Indicate the importance of this issue to you (blocker, must-have, should-have, nice-to-have). Are you currently using any workarounds to address this issue? + +3. Provide any additional detail on your proposed use case for this feature. + +4. If there are some sub-tasks using -[] for each subtask and create a corresponding issue to map to the sub task: +- [ ] [sub-task1-issue-number](example_sub_issue1_link_here): sub-task1 discription here, +- [ ] [sub-task2-issue-number](example_sub_issue2_link_here): sub-task2 discription here, +- ... + + +**BUG REPORT** + +1. Please describe the issue you observed: + +- What did you do? + +- What did you expect to see? + +- What did you see instead? + +--------------------------------------------------------------------------------- + +Please label the issue with proper labels. It would help us triage the issues. + +- "release/": please mark the issue with the release. +- "type/": please mark the issue with corresponding issue type. http://git-wip-us.apache.org/repos/asf/bookkeeper/blob/363c5d00/.github/PULL_REQUEST_TEMPLATE.md ---------------------------------------------------------------------- diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..6c55440 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,15 @@ +Descriptions of the changes in this PR: + +xxxxxx + +--- +Be sure to do all of the following to help us incorporate your contribution +quickly and easily: + +- [ ] Make sure the PR title is formatted like: + `<Issue #>: Description of pull request` + `e.g. Issue 123: Description ...` +- [ ] Make sure tests pass via `mvn clean apache-rat:check install findbugs:check`. +- [ ] Replace `<Issue #>` in the title with the actual Issue number, if there is one. + +--- http://git-wip-us.apache.org/repos/asf/bookkeeper/blob/363c5d00/pom.xml ---------------------------------------------------------------------- diff --git a/pom.xml b/pom.xml index 48233c3..2a4e283 100644 --- a/pom.xml +++ b/pom.xml @@ -121,6 +121,7 @@ <configuration> <excludes> <exclude>.git/**/*</exclude> + <exclude>.github/**/*</exclude> <exclude>**/target/**/*</exclude> <exclude>**/.svn/**/*</exclude> <exclude>CHANGES.txt</exclude>
