You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@hugegraph.apache.org by GitBox <gi...@apache.org> on 2022/04/19 12:14:08 UTC

[GitHub] [incubator-hugegraph-toolchain] simon824 opened a new pull request, #265: [Feature] Update issue template

simon824 opened a new pull request, #265:
URL: https://github.com/apache/incubator-hugegraph-toolchain/pull/265

   closed #264


-- 
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: dev-unsubscribe@hugegraph.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [incubator-hugegraph-toolchain] imbajin commented on pull request #265: [Feature] Update issue template

Posted by GitBox <gi...@apache.org>.
imbajin commented on PR #265:
URL: https://github.com/apache/incubator-hugegraph-toolchain/pull/265#issuecomment-1102730778

   And we also need translate other template like `Bug` & `Question`, could enhance them together after a basic & unify format ensure


-- 
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: dev-unsubscribe@hugegraph.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [incubator-hugegraph-toolchain] javeme merged pull request #265: chore: Update issue template

Posted by GitBox <gi...@apache.org>.
javeme merged PR #265:
URL: https://github.com/apache/incubator-hugegraph-toolchain/pull/265


-- 
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: commits-unsubscribe@hugegraph.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [incubator-hugegraph-toolchain] imbajin commented on a diff in pull request #265: [Feature] Update issue template

Posted by GitBox <gi...@apache.org>.
imbajin commented on code in PR #265:
URL: https://github.com/apache/incubator-hugegraph-toolchain/pull/265#discussion_r853140210


##########
.github/ISSUE_TEMPLATE/feature_request.yml:
##########
@@ -1,15 +1,83 @@
-name: Feature request (新需求 / 功能)
-description: Give an idea for HugeGraph
-title: '[Feature] describe the new feature'
-labels:
-  - feature
-
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+name: Feature request
+description: Suggest an idea for hugegraph-toolchain
+title: "[Feature][Module Name] Feature title"
+labels: ["Feature"]

Review Comment:
   we don't need use uppercase, the issue label is lowercase usually 



##########
.github/ISSUE_TEMPLATE/feature_request.yml:
##########
@@ -1,15 +1,83 @@
-name: Feature request (新需求 / 功能)
-description: Give an idea for HugeGraph
-title: '[Feature] describe the new feature'
-labels:
-  - feature
-
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#

Review Comment:
   we don't need add license in non-code files



##########
.github/ISSUE_TEMPLATE/feature_request.yml:
##########
@@ -1,15 +1,83 @@
-name: Feature request (新需求 / 功能)
-description: Give an idea for HugeGraph
-title: '[Feature] describe the new feature'
-labels:
-  - feature
-
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+name: Feature request
+description: Suggest an idea for hugegraph-toolchain
+title: "[Feature][Module Name] Feature title"

Review Comment:
   consider keep the `tag` simplify for user friendly, the module name could be mentioned in title content



-- 
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: dev-unsubscribe@hugegraph.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [incubator-hugegraph-toolchain] javeme commented on a diff in pull request #265: chore: Update issue template

Posted by GitBox <gi...@apache.org>.
javeme commented on code in PR #265:
URL: https://github.com/apache/incubator-hugegraph-toolchain/pull/265#discussion_r902281241


##########
.github/ISSUE_TEMPLATE/question_ask.yml:
##########
@@ -1,79 +1,76 @@
-name: Ask question (提问)
-description: Question about usage or configs in HugeGraph
-title: '[Question] describe your problem'
+name: Ask question
+description: Question about usage or configs in hugegraph-toolchain
+title: '[Question] Describe your problem'
 
 body:
   - type: markdown
     attributes:
-      value: >-
-        ### Note (特别注意) : 
-
-        > 1. 请先**搜索**现有的[Server-Issues](https://github.com/hugegraph/hugegraph/issues) 与
-        [Toolchain-Issues](https://github.com/hugegraph/hugegraph-loader/issues) 中没有与您相同
-        / 相关的问题 (请勿重复提交)
+      value: |
+        Please make sure what you are reporting is indeed a bug with reproducible steps.
 
-        > 2. 我们需要尽可能**详细**的信息来**复现**问题, 越详细的信息 (包括**日志 / 截图 / 配置**等)
-        会**越快**被响应和处理
+        For better global communication, Please write in English.If you feel the description in English is not clear, then you can append description in Chinese, thanks!
 
-        > 3. Issue 标题请保持原有模板分类(例如:`[Bug]`), 长段描述之间可以增加`空行`或使用`序号`标记, 保持排版清晰
+        Please submit an issue in the corresponding module, if lack of valid information or no respond for a long time (> 14 days), issues may be **closed** (will be reopened when updated)
 
-        > 4. 请在对应的模块提交 issue, 缺乏有效信息 / 长时间 (> 14 天) 没有回复的 issue 可能会被 **关闭**
-        (更新时会再开启)
-  
   - type: dropdown
     attributes:
-      label: Problem Type (问题类型)
+      label: Problem Type
       options:
-        - gremlin (结果不合预期)
-        - rest-api (结果不合预期)
-        - logic (逻辑设计问题)
-        - performence (性能问题)
-        - dashboard render (前端渲染问题)
-        - data inconsistency (数据不一致)
-        - configs (配置项 / 文档相关)
-        - exception / error (异常报错)

Review Comment:
   Sorry, I didn't notice this PR before.
   I think we can provide some key steps in both English and Chinese, such as titles or guiding steps, maybe that is friendly to domestic users.



-- 
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: commits-unsubscribe@hugegraph.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [incubator-hugegraph-toolchain] imbajin commented on a diff in pull request #265: [Feature] Update issue template

Posted by GitBox <gi...@apache.org>.
imbajin commented on code in PR #265:
URL: https://github.com/apache/incubator-hugegraph-toolchain/pull/265#discussion_r853131860


##########
.github/ISSUE_TEMPLATE/feature_request.yml:
##########
@@ -1,15 +1,83 @@
-name: Feature request (新需求 / 功能)
-description: Give an idea for HugeGraph
-title: '[Feature] describe the new feature'
-labels:
-  - feature
-
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#

Review Comment:
   we don't need add license in non-code/ci files



-- 
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: dev-unsubscribe@hugegraph.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [incubator-hugegraph-toolchain] simon824 commented on pull request #265: chore: Update issue template

Posted by GitBox <gi...@apache.org>.
simon824 commented on PR #265:
URL: https://github.com/apache/incubator-hugegraph-toolchain/pull/265#issuecomment-1161549064

   We can check the effect after modify here
   - https://github.com/simon824/incubator-hugegraph-toolchain/blob/issue/.github/ISSUE_TEMPLATE/question_ask.yml
   - https://github.com/simon824/incubator-hugegraph-toolchain/blob/issue/.github/ISSUE_TEMPLATE/feature_request.yml
   - https://github.com/simon824/incubator-hugegraph-toolchain/blob/issue/.github/ISSUE_TEMPLATE/bug_report.yml
   


-- 
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: commits-unsubscribe@hugegraph.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [incubator-hugegraph-toolchain] javeme commented on a diff in pull request #265: chore: Update issue template

Posted by GitBox <gi...@apache.org>.
javeme commented on code in PR #265:
URL: https://github.com/apache/incubator-hugegraph-toolchain/pull/265#discussion_r905683372


##########
.github/ISSUE_TEMPLATE/question_ask.yml:
##########
@@ -38,28 +32,28 @@ body:
     attributes:
       label: Before submit
       options:
-        - label: 我已经确认现有的 [Server-Issues](https://github.com/hugegraph/hugegraph/issues) 与 [Toolchain-Issues](https://github.com/hugegraph/hugegraph-loader/issues) 中没有相同 / 重复问题
+        - label: I had searched in the [issues](https://github.com/hugegraph/hugegraph-loader/issues) and found no similar issues.
           required: true
 
   - type: textarea
     attributes:
       label: Environment (环境信息)
       description: |
-        > server version could get from [rest-api](https://hugegraph.github.io/hugegraph-doc/clients/restful-api/other.html) (http://localhost:8080/versions)
+         server version could get from [rest-api](https://hugegraph.github.io/hugegraph-doc/clients/restful-api/other.html) (http://localhost:8080/versions)
       value: |
         - Server Version: v0.12.x
         - Loader Version: v0.12.x
         - Data Size:  xx vertices, xx edges <!-- (like 1000W 点, 9000W 边) -->
     validations:
       required: true
-  
+
   - type: textarea
     attributes:
       label: Your Question (问题描述)
       description: |
-        > 图使用 / 配置相关问题，请优先参考 [REST-API 文档](https://hugegraph.github.io/hugegraph-doc/clients/hugegraph-api.html), 以及 [Server 配置文档](https://hugegraph.github.io/hugegraph-doc/config/config-option.html)
-        > if possible, please provide screenshots or GIF (请提供清晰的截图, 动图录屏更佳)
-      placeholder: |        
+        For issues related to graph usage/configuration, please refer to [REST-API documentation](https://hugegraph.github.io/hugegraph-doc/clients/hugegraph-api.html), and [Server configuration documentation](https:/ /hugegraph.github.io/hugegraph-doc/config/config-option.html) (if possible, please provide screenshots or GIF).
+        图使用 / 配置相关问题，请优先参考 [REST-API 文档](https://hugegraph.github.io/hugegraph-doc/clients/hugegraph-api.html), 以及 [Server 配置文档](https://hugegraph.github.io/hugegraph-doc/config/config-option.html) (请提供清晰的截图, 动图录屏更佳)

Review Comment:
   use hugegraph.apache.org instead of hugegraph.github.io? like:
   https://hugegraph.github.io/hugegraph-doc/config/config-option.html
   =>
   https://hugegraph.apache.org/docs/config/config-option/



-- 
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: commits-unsubscribe@hugegraph.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [incubator-hugegraph-toolchain] simon824 commented on a diff in pull request #265: [Feature] Update issue template

Posted by GitBox <gi...@apache.org>.
simon824 commented on code in PR #265:
URL: https://github.com/apache/incubator-hugegraph-toolchain/pull/265#discussion_r853651251


##########
.github/ISSUE_TEMPLATE/feature_request.yml:
##########
@@ -1,15 +1,83 @@
-name: Feature request (新需求 / 功能)
-description: Give an idea for HugeGraph
-title: '[Feature] describe the new feature'
-labels:
-  - feature
-
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+name: Feature request
+description: Suggest an idea for hugegraph-toolchain
+title: "[Feature][Module Name] Feature title"

Review Comment:
   Actually, as a project consisting of multiple modules, I think it would be better to add a module name here as a reminder, and the title may be confusing if miss module name.
   



-- 
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: dev-unsubscribe@hugegraph.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [incubator-hugegraph-toolchain] simon824 commented on pull request #265: [Feature] Update issue template

Posted by GitBox <gi...@apache.org>.
simon824 commented on PR #265:
URL: https://github.com/apache/incubator-hugegraph-toolchain/pull/265#issuecomment-1103336275

   > And we also need translate other template like `Bug` & `Question`, could enhance them together after a basic & unify format ensure
   
   Get it ,thanks for your review.


-- 
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: dev-unsubscribe@hugegraph.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [incubator-hugegraph-toolchain] imbajin commented on pull request #265: [Feature] Update issue template

Posted by GitBox <gi...@apache.org>.
imbajin commented on PR #265:
URL: https://github.com/apache/incubator-hugegraph-toolchain/pull/265#issuecomment-1104760598

   <img width="972" alt="image" src="https://user-images.githubusercontent.com/17706099/164386984-09f74929-b35a-48ac-ba45-dd0e7305195a.png">
   
   we could paste the Actual Rendering Pic here to diff them


-- 
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: commits-unsubscribe@hugegraph.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [incubator-hugegraph-toolchain] github-actions[bot] commented on pull request #265: chore: Update issue template

Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on PR #265:
URL: https://github.com/apache/incubator-hugegraph-toolchain/pull/265#issuecomment-1140036868

   Due to the lack of activity, the current pr is marked as stale and will be closed after 180 days, any update will remove the stale label


-- 
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: commits-unsubscribe@hugegraph.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [incubator-hugegraph-toolchain] imbajin commented on a diff in pull request #265: chore: Update issue template

Posted by GitBox <gi...@apache.org>.
imbajin commented on code in PR #265:
URL: https://github.com/apache/incubator-hugegraph-toolchain/pull/265#discussion_r884066771


##########
.github/ISSUE_TEMPLATE/question_ask.yml:
##########
@@ -1,79 +1,76 @@
-name: Ask question (提问)
-description: Question about usage or configs in HugeGraph
-title: '[Question] describe your problem'
+name: Ask question
+description: Question about usage or configs in hugegraph-toolchain
+title: '[Question] Describe your problem'
 
 body:
   - type: markdown
     attributes:
-      value: >-
-        ### Note (特别注意) : 
-
-        > 1. 请先**搜索**现有的[Server-Issues](https://github.com/hugegraph/hugegraph/issues) 与
-        [Toolchain-Issues](https://github.com/hugegraph/hugegraph-loader/issues) 中没有与您相同
-        / 相关的问题 (请勿重复提交)
+      value: |
+        Please make sure what you are reporting is indeed a bug with reproducible steps.
 
-        > 2. 我们需要尽可能**详细**的信息来**复现**问题, 越详细的信息 (包括**日志 / 截图 / 配置**等)
-        会**越快**被响应和处理
+        For better global communication, Please write in English.If you feel the description in English is not clear, then you can append description in Chinese, thanks!
 
-        > 3. Issue 标题请保持原有模板分类(例如:`[Bug]`), 长段描述之间可以增加`空行`或使用`序号`标记, 保持排版清晰
+        Please submit an issue in the corresponding module, if lack of valid information or no respond for a long time (> 14 days), issues may be **closed** (will be reopened when updated)
 
-        > 4. 请在对应的模块提交 issue, 缺乏有效信息 / 长时间 (> 14 天) 没有回复的 issue 可能会被 **关闭**
-        (更新时会再开启)
-  
   - type: dropdown
     attributes:
-      label: Problem Type (问题类型)
+      label: Problem Type
       options:
-        - gremlin (结果不合预期)
-        - rest-api (结果不合预期)
-        - logic (逻辑设计问题)
-        - performence (性能问题)
-        - dashboard render (前端渲染问题)
-        - data inconsistency (数据不一致)
-        - configs (配置项 / 文档相关)
-        - exception / error (异常报错)

Review Comment:
   @javeme  shall we keep chinese content? if we don't have it, seems we need another CN version (CN users >95%)



##########
.github/ISSUE_TEMPLATE/question_ask.yml:
##########
@@ -1,79 +1,76 @@
-name: Ask question (提问)
-description: Question about usage or configs in HugeGraph
-title: '[Question] describe your problem'
+name: Ask question
+description: Question about usage or configs in hugegraph-toolchain
+title: '[Question] Describe your problem'
 
 body:
   - type: markdown
     attributes:
-      value: >-
-        ### Note (特别注意) : 
-
-        > 1. 请先**搜索**现有的[Server-Issues](https://github.com/hugegraph/hugegraph/issues) 与
-        [Toolchain-Issues](https://github.com/hugegraph/hugegraph-loader/issues) 中没有与您相同
-        / 相关的问题 (请勿重复提交)
+      value: |
+        Please make sure what you are reporting is indeed a bug with reproducible steps.
 
-        > 2. 我们需要尽可能**详细**的信息来**复现**问题, 越详细的信息 (包括**日志 / 截图 / 配置**等)
-        会**越快**被响应和处理
+        For better global communication, Please write in English.If you feel the description in English is not clear, then you can append description in Chinese, thanks!
 
-        > 3. Issue 标题请保持原有模板分类(例如:`[Bug]`), 长段描述之间可以增加`空行`或使用`序号`标记, 保持排版清晰
+        Please submit an issue in the corresponding module, if lack of valid information or no respond for a long time (> 14 days), issues may be **closed** (will be reopened when updated)
 
-        > 4. 请在对应的模块提交 issue, 缺乏有效信息 / 长时间 (> 14 天) 没有回复的 issue 可能会被 **关闭**

Review Comment:
   here we could give 2 language version, or keep only EN one



-- 
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: commits-unsubscribe@hugegraph.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [incubator-hugegraph-toolchain] simon824 commented on pull request #265: [Feature] Update issue template

Posted by GitBox <gi...@apache.org>.
simon824 commented on PR #265:
URL: https://github.com/apache/incubator-hugegraph-toolchain/pull/265#issuecomment-1104798955

   ![image](https://user-images.githubusercontent.com/18065113/164394309-95f6b178-12ed-41ac-85f8-ea6c58090897.png)
   ![image](https://user-images.githubusercontent.com/18065113/164394338-80bb8522-918b-47e4-9c4d-845fccd1b7a6.png)
   @imbajin 


-- 
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: commits-unsubscribe@hugegraph.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org