You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by to...@apache.org on 2022/07/18 06:33:06 UTC
[lucene] branch main updated: LUCENE-10557: Add GitHub issue templates (#1024)
This is an automated email from the ASF dual-hosted git repository.
tomoko pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/lucene.git
The following commit(s) were added to refs/heads/main by this push:
new 8938e6a3fab LUCENE-10557: Add GitHub issue templates (#1024)
8938e6a3fab is described below
commit 8938e6a3fab56e1037feb86db398d71e269dcf34
Author: Tomoko Uchida <to...@gmail.com>
AuthorDate: Mon Jul 18 15:33:00 2022 +0900
LUCENE-10557: Add GitHub issue templates (#1024)
---
.github/ISSUE_TEMPLATE/bug_report.yaml | 15 ++++++
.github/ISSUE_TEMPLATE/documentation.yaml | 10 ++++
.github/ISSUE_TEMPLATE/enhancement_request.yaml | 10 ++++
.github/ISSUE_TEMPLATE/task.yaml | 10 ++++
.github/ISSUE_TEMPLATE/test.yaml | 15 ++++++
dev-docs/github-issues-howto.md | 61 +++++++++++++++++++++++++
6 files changed, 121 insertions(+)
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml
new file mode 100644
index 00000000000..a24173d572d
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.yaml
@@ -0,0 +1,15 @@
+name: Bug Report
+description: File a bug report
+labels: ["type:bug"]
+body:
+ - type: textarea
+ id: description
+ attributes:
+ label: Description
+ validations:
+ required: true
+ - type: textarea
+ id: environment
+ attributes:
+ label: Version and environment details
+ placeholder: Specify what Lucene version you are using and/or environment details (e.g., OS and JVM runtime)
diff --git a/.github/ISSUE_TEMPLATE/documentation.yaml b/.github/ISSUE_TEMPLATE/documentation.yaml
new file mode 100644
index 00000000000..df059686daf
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/documentation.yaml
@@ -0,0 +1,10 @@
+name: Documentation Improvement
+description: File a task relates to documentation
+labels: ["type:documentation"]
+body:
+ - type: textarea
+ id: description
+ attributes:
+ label: Description
+ validations:
+ required: true
diff --git a/.github/ISSUE_TEMPLATE/enhancement_request.yaml b/.github/ISSUE_TEMPLATE/enhancement_request.yaml
new file mode 100644
index 00000000000..46687ad7118
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/enhancement_request.yaml
@@ -0,0 +1,10 @@
+name: Enhancement Request/Suggestion
+description: File an enhancement request or suggestion
+labels: ["type:enhancement"]
+body:
+ - type: textarea
+ id: description
+ attributes:
+ label: Description
+ validations:
+ required: true
diff --git a/.github/ISSUE_TEMPLATE/task.yaml b/.github/ISSUE_TEMPLATE/task.yaml
new file mode 100644
index 00000000000..10b00630744
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/task.yaml
@@ -0,0 +1,10 @@
+name: Task
+description: File a general task
+labels: ["type:task"]
+body:
+ - type: textarea
+ id: description
+ attributes:
+ label: Description
+ validations:
+ required: true
diff --git a/.github/ISSUE_TEMPLATE/test.yaml b/.github/ISSUE_TEMPLATE/test.yaml
new file mode 100644
index 00000000000..ddb7e6f57b7
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/test.yaml
@@ -0,0 +1,15 @@
+name: Test Improvement / Failure Report
+description: File a task relates to test
+labels: ["type:test"]
+body:
+ - type: textarea
+ id: description
+ attributes:
+ label: Description
+ validations:
+ required: true
+ - type: textarea
+ id: environment
+ attributes:
+ label: Gradle command to reproduce
+ placeholder: Specify the gradle command to reproduce the failure
diff --git a/dev-docs/github-issues-howto.md b/dev-docs/github-issues-howto.md
new file mode 100644
index 00000000000..4558d78777f
--- /dev/null
+++ b/dev-docs/github-issues-howto.md
@@ -0,0 +1,61 @@
+<!--
+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.
+-->
+
+# GitHub Issues How-To Manual
+
+## Issue labels
+
+There are a few pre-fixed label families to organize/search issues.
+
+- `type` : issue type
+ - `type:bug` is attached to bug reports
+ - `type:enhancement` is attached to enhancement requests or suggestions
+ - `type:test` is attached to test improvements or failure reports
+ - `type:task` is attached to general tasks
+ - `type:documentation` is attached to tasks relate to documentation
+- `fixVersion` : the versions in which a bug or enhancement is planned to be released
+ - this may be used for release planning
+ - (example) `fixVersion:10.0.0`
+- `affectsVersion` : the versions in which a bug was found
+ - this may be used with `type:bug`
+ - (example) `affectsVersion:9.1.0`
+- `component` : Lucene components
+ - (example) `components:module/core/index`, `component:module/analysis`
+
+A `type` label is automatically attached to an issue by the issue template that the reporter selected. Other labels such as `component` may be manually added by committers.
+
+If necessary, uncategorized labels may also be used.
+
+- `good first issue`
+- `discuss`
+- `duplicate`
+
+Committers can add/edit labels manually or programmatically using [Labels API](https://docs.github.com/en/rest/issues/labels).
+
+## Issue templates
+
+Each issue template (web form) is associated with one `type` label. You should add an issue template when adding a new `type` label and vice versa.
+
+- `Bug Report` is associated with `type:bug` label
+- `Enhancement Request/Suggestion` is associated with `type:enhancement` label
+- `Test Improvement / Failure Report` is associated with `type:test` label
+- `Task` is associated with `type:task` label
+- `Documentation` is associated with `type:documentation` label
+
+Issue templates are written in YAML format and committed in `.github/ISSUE_TEMPLATE`. See [GitHub documentation](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms) for details.
\ No newline at end of file