You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@hugegraph.apache.org by "Radeity (via GitHub)" <gi...@apache.org> on 2023/05/19 16:12:08 UTC
[GitHub] [incubator-hugegraph-computer] Radeity opened a new pull request, #242: [Feature-241] Add PULL_REQUEST_TEMPLATE
Radeity opened a new pull request, #242:
URL: https://github.com/apache/incubator-hugegraph-computer/pull/242
<!--
Thank you very much for contributing to Apache HugeGraph, we are happy that you want to help us improve HugeGraph!
Here are some tips for you:
1. If this is your first time, please read the [contributing guidelines](https://github.com/apache/incubator-hugegraph/blob/f23c648937c8c4601a9f721d688eabfec7a8cfb3/CONTRIBUTING.md).
2. Replace texts surrounded by `<` and `>` based on your pull request, e.g. <ISSUE NUMBER>.
3. Name the pull request in the form "[<TYPE>-<ISSUE NUMBER>] [<COMPONENT>] Title of the pull request",
where <TYPE> should be clear, such as: Feature | Fix | Improvement | Refactor | Revert | Chore,
<ISSUE NUMBER> should be replaced by the actual issue number.
Skip <COMPONENT> if you are unsure about which is the best component.
4. Each pull request should address only one issue, not mix up code from multiple issues.
5. Put an `x` in the `[ ]` to mark the item as CHECKED. `[x]`
-->
## Purpose of the pull request
- This PR will close https://github.com/apache/incubator-hugegraph-computer/issues/241
- Add pull request template to normalize pr information.
<!-- 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. -->
## Summary of changes
- Ditto.
<!-- 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 this change
<!-- Please pick either of the following options -->
- This change is a doc work without any test coverage.
## Does this pull request potentially affect one of the following parts:
<!-- DO NOT REMOVE THIS SECTION. CHECK THE PROPER BOX ONLY. -->
- [ ] Dependencies (add or upgrade a dependency, do not forget to add license)
- [ ] The public API
- [ ] The default values of configurations
- [ ] The CRD generation script
- [ ] The Kubernetes Operator
- [ ] Anything that affects deployment
## Documentation
<!-- DO NOT REMOVE THIS SECTION. CHECK THE PROPER BOX ONLY. -->
- [ ] `doc-required` <!-- Your PR changes impact docs and you will update later -->
- [x] `doc-not-needed` <!-- Your PR changes do not impact docs -->
- [ ] `doc-complete` <!-- Related docs have been already added or updated -->
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
[GitHub] [incubator-hugegraph-computer] liuxiaocs7 commented on a diff in pull request #242: [Feature-241] Add PULL_REQUEST_TEMPLATE
Posted by "liuxiaocs7 (via GitHub)" <gi...@apache.org>.
liuxiaocs7 commented on code in PR #242:
URL: https://github.com/apache/incubator-hugegraph-computer/pull/242#discussion_r1200757546
##########
.github/PULL_REQUEST_TEMPLATE.md:
##########
@@ -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 "fix #xx" (xx = issue number) 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 -->
Review Comment:
nit: should we use `close: #issue_number` here to be consistent with L7 and L26
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
[GitHub] [incubator-hugegraph-computer] imbajin commented on pull request #242: [Feature-241] Add PULL_REQUEST_TEMPLATE
Posted by "imbajin (via GitHub)" <gi...@apache.org>.
imbajin commented on PR #242:
URL: https://github.com/apache/incubator-hugegraph-computer/pull/242#issuecomment-1555911622
> Hi, @imbajin , I don't recommend removing section `Verifying these changes`, how to test this pr is important, sometimes, it can not be tested by regular UT, also, it helps reviewer to know more about its degree of completion. Maybe we can simplify this section first, WDYT?
Fine, use a short description for it first 🩳
BTW, the reason why I simplify the template is because in the “markdown source code” mode, most new users will directly “select all + delete” the content😿 (same in title), we had a similar problem with our previous **issue template**, until I used a **new UI** refactoring and did not allow it to be deleted (but the New Table UI can't use in PR template)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
[GitHub] [incubator-hugegraph-computer] codecov[bot] commented on pull request #242: [Feature-241] Add PULL_REQUEST_TEMPLATE
Posted by "codecov[bot] (via GitHub)" <gi...@apache.org>.
codecov[bot] commented on PR #242:
URL: https://github.com/apache/incubator-hugegraph-computer/pull/242#issuecomment-1554999758
## [Codecov](https://app.codecov.io/gh/apache/incubator-hugegraph-computer/pull/242?src=pr&el=h1&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) Report
> Merging [#242](https://app.codecov.io/gh/apache/incubator-hugegraph-computer/pull/242?src=pr&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) (f2a0b1b) into [master](https://app.codecov.io/gh/apache/incubator-hugegraph-computer/commit/cc5a7e727d42b5139fc8f5c3bea9ce55a05c9263?el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) (cc5a7e7) will **increase** coverage by `0.04%`.
> The diff coverage is `n/a`.
```diff
@@ Coverage Diff @@
## master #242 +/- ##
============================================
+ Coverage 85.83% 85.87% +0.04%
Complexity 3232 3232
============================================
Files 344 344
Lines 12072 12072
Branches 1087 1087
============================================
+ Hits 10362 10367 +5
+ Misses 1185 1179 -6
- Partials 525 526 +1
```
[see 3 files with indirect coverage changes](https://app.codecov.io/gh/apache/incubator-hugegraph-computer/pull/242/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache)
:mega: We’re building smart automated test selection to slash your CI/CD build times. [Learn more](https://about.codecov.io/iterative-testing/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
[GitHub] [incubator-hugegraph-computer] Radeity commented on pull request #242: [Feature-241] Add PULL_REQUEST_TEMPLATE
Posted by "Radeity (via GitHub)" <gi...@apache.org>.
Radeity commented on PR #242:
URL: https://github.com/apache/incubator-hugegraph-computer/pull/242#issuecomment-1557552356
> nit: should we use close: #issue_number here to be consistent with L7 and L26
Hi, @liuxiaocs7 , thanks for reminding, I think use link here is better, so i've modified comment in L7 :D
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
[GitHub] [incubator-hugegraph-computer] Radeity commented on pull request #242: [Feature-241] Add PULL_REQUEST_TEMPLATE
Posted by "Radeity (via GitHub)" <gi...@apache.org>.
Radeity commented on PR #242:
URL: https://github.com/apache/incubator-hugegraph-computer/pull/242#issuecomment-1555910482
Hi, @imbajin , I don't recommend removing section `Verifying these changes`, how to test this pr is important, sometimes, it can not be tested by regular UT, also, it helps reviewer to know more about its degree of completion, WDYT?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
[GitHub] [incubator-hugegraph-computer] imbajin commented on pull request #242: [Feature-241] Add PULL_REQUEST_TEMPLATE
Posted by "imbajin (via GitHub)" <gi...@apache.org>.
imbajin commented on PR #242:
URL: https://github.com/apache/incubator-hugegraph-computer/pull/242#issuecomment-1555907969
simplify it first, gradually adjust it according to the usage/feedback
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
[GitHub] [incubator-hugegraph-computer] Radeity commented on pull request #242: [Feature-241] Add PULL_REQUEST_TEMPLATE
Posted by "Radeity (via GitHub)" <gi...@apache.org>.
Radeity commented on PR #242:
URL: https://github.com/apache/incubator-hugegraph-computer/pull/242#issuecomment-1555913944
>
> Fine, use a short 🩳 description for it first, thanks for the feedback
>
> BTW, the reason why I simplify the template is because in the “markdown source code” mode, most new users will directly “select all + delete” the content😿 (same in title), we had a similar problem with our previous **issue template**, until I used a **new UI** refactoring and did not allow it to be deleted (but the New Table UI can't use in PR template)
Get your point :D, and i've modified some description, maybe this part can be improved, PTAL: https://github.com/Radeity/incubator-hugegraph-computer/blob/31ea3e02b731255f42e877dd82ee45d0a1f5182d/.github/PULL_REQUEST_TEMPLATE.md?plain=1#L51-L54
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
[GitHub] [incubator-hugegraph-computer] liuxiaocs7 commented on pull request #242: [Feature-241] Add PULL_REQUEST_TEMPLATE
Posted by "liuxiaocs7 (via GitHub)" <gi...@apache.org>.
liuxiaocs7 commented on PR #242:
URL: https://github.com/apache/incubator-hugegraph-computer/pull/242#issuecomment-1559789039
> LGTM, unify it in other repo later
Added in the [task](https://github.com/orgs/apache/projects/263), good start for beginner by refering this pr!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org
[GitHub] [incubator-hugegraph-computer] coderzc merged pull request #242: [Feature-241] Add PULL_REQUEST_TEMPLATE
Posted by "coderzc (via GitHub)" <gi...@apache.org>.
coderzc merged PR #242:
URL: https://github.com/apache/incubator-hugegraph-computer/pull/242
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@hugegraph.apache.org
For additional commands, e-mail: issues-help@hugegraph.apache.org