-
Notifications
You must be signed in to change notification settings - Fork 41
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Feature-241] Add PULL_REQUEST_TEMPLATE (#242)
- Loading branch information
Showing
1 changed file
with
73 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| <!-- | ||
| Thank you very much for contributing to Apache HugeGraph, we are happy that you want to help us improve it! | ||
| Here are some tips for you: | ||
| 1. If this is your first time, please read the [contributing guidelines](https://github.com/apache/hugegraph/blob/master/CONTRIBUTING.md) | ||
| 2. If a PR will fix/close a issue, type the message "close xxx" (xxx is the link of related issue) in the content, github will auto link it (Required) | ||
| 3. Name the PR title in "Google Commit Format", start with "feat | fix | perf | refactor | doc | chore", | ||
| such like: "feat(core): support the PageRank algorithm" or "fix: wrong break in the compute loop" (module is optional) | ||
| skip it if you are unsure about which is the best component. | ||
| 4. One PR address one issue, better not to mix up multiple issues. | ||
| 5. Put an `x` in the `[ ]` to mark the item as CHECKED. `[x]` (or click it directly after published) | ||
| --> | ||
|
|
||
| ## Purpose of the PR | ||
|
|
||
| - close: xxx <!-- or use "fix: xxx", "xxx" is the link of related issue --> | ||
|
|
||
| <!-- | ||
| Please explain more context in this section, clarify why the changes are needed. | ||
| For example: | ||
| - If you propose a new API, clarify the use case for a new API. | ||
| - If you fix a bug, you can clarify why it is a bug, and should associated with an issue. | ||
| --> | ||
|
|
||
| ## Main Changes | ||
|
|
||
| <!-- Please clarify what changes you are proposing. The purpose of this section is to outline the changes and how this PR fixes the issue. These change logs are helpful for better ant faster reviews.) | ||
| For example: | ||
| - If you introduce a new feature, please show detailed design here or add the link of design documentation. | ||
| - If you refactor some codes with changing classes, showing the class hierarchy will help reviewers. | ||
| - If there is a discussion in the mailing list, please add the link. --> | ||
|
|
||
| ## Verifying these changes | ||
|
|
||
| <!-- Please pick either of the following options --> | ||
|
|
||
| - This change is a trivial rework / code cleanup without any test coverage. | ||
|
|
||
| *(or)* | ||
|
|
||
| - This change is already covered by existing tests, such as *(please describe tests)*. | ||
|
|
||
| *(or)* | ||
|
|
||
| - This change added tests and can be verified as follows: | ||
|
|
||
| *(for example:)* | ||
| - *Add UT.* | ||
|
|
||
|
|
||
| ## Does this PR potentially affect the following parts? | ||
|
|
||
| <!-- DO NOT REMOVE THIS SECTION. CHECK THE PROPER BOX ONLY. --> | ||
|
|
||
| - [ ] Nope | ||
| - [ ] Dependencies (add/update license info) <!-- Don't forget to add/update the info in "LICENSE" & "NOTICE" files (both in root & dist module) --> | ||
| - [ ] Modify configurations | ||
| - [ ] The public API | ||
| - [ ] Other affects (typed here) | ||
|
|
||
| ## Documentation Status | ||
|
|
||
| <!-- DO NOT REMOVE THIS SECTION. CHECK THE PROPER BOX ONLY. --> | ||
|
|
||
| - [ ] `Doc - TODO` <!-- Your PR changes impact docs and you will update later --> | ||
| - [ ] `Doc - Done` <!-- Related docs have been already added or updated --> | ||
| - [ ] `Doc - NO Need` <!-- Your PR changes don't impact/need docs --> |