-
Notifications
You must be signed in to change notification settings - Fork 517
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
chore: add pr template #2234
Merged
Merged
chore: add pr template #2234
Changes from 3 commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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,66 @@ | ||
<!-- | ||
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 fix/close an 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 ID-link of related issue, e.g: close #1024 --> | ||
|
||
<!-- | ||
Please explain more context in this section, clarify why the changes are needed. | ||
e.g: | ||
- 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 be 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 the proper options below --> | ||
|
||
- [ ] Trivial rework / code cleanup without any test coverage. (No Need) | ||
- [ ] Already covered by existing tests, such as *(please modify tests here)*. | ||
- [ ] Need tests and can be verified as follows: | ||
- xxx | ||
|
||
## 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 --> | ||
liuxiaocs7 marked this conversation as resolved.
Show resolved
Hide resolved
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
keep "None"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't quite understand, could you explain in more detail? :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
mean that we prefer to replace "xxx" with "None" since we may not need to test manually and modify the default list.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
None
seems duplicate with the first option (No Need), and devs could remove it manually, we could test & enhance it later (listen the users feedback)