You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by vy...@apache.org on 2023/01/24 18:45:46 UTC
[logging-log4j-tools] 01/03: Clean-up GitHub templates
This is an automated email from the ASF dual-hosted git repository.
vy pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/logging-log4j-tools.git
commit 30724a7e0979eb789f5f56a62f1a0257940462d2
Author: Volkan Yazıcı <vo...@yazi.ci>
AuthorDate: Sun Jan 22 21:15:43 2023 +0100
Clean-up GitHub templates
---
.github/ISSUE_TEMPLATE/bug_report.md | 28 +++++++++-------------------
.github/ISSUE_TEMPLATE/feature_request.md | 20 ++++----------------
.github/ISSUE_TEMPLATE/question.md | 15 ---------------
.github/pull_request_template.md | 8 ++++++++
log4j-tools-parent/pom.xml | 3 +++
5 files changed, 24 insertions(+), 50 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index 3520d6b..0ca2a07 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -1,18 +1,3 @@
-# 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
-#
-# https://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: Bug report
about: Submit a bug report
@@ -20,18 +5,23 @@ about: Submit a bug report
## Description
-A clear and concise description of what the bug is.
+[A clear and concise description of what the bug is.]
## Configuration
-**Version:** ...
+**Version:** [`log4j-tools` version]
-**Operating system:** ...
+**Operating system:** [OS and version]
-**JDK:** ...
+**JDK:** [JDK distribution and version]
## Logs
```
Stacktraces, errors, etc. relevant applications logs.
```
+
+## Reproduction
+
+[An isolated test reproducing the test.
+JUnit tests similar to the ones in the code base are extremely appreciated.]
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
index 301c59a..57770a1 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -1,21 +1,9 @@
-# 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
-#
-# https://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
about: Submit a feature request
---
-A clear and concise description of feature requested.
+**Warning!**
+It is highly recommended to discuss feature requests in [the mailing lists](https://logging.apache.org/log4j/2.x/support.html) first.
+
+[A clear and concise description of the feature requested.]
diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md
index f64cccd..33c2d46 100644
--- a/.github/ISSUE_TEMPLATE/question.md
+++ b/.github/ISSUE_TEMPLATE/question.md
@@ -1,18 +1,3 @@
-# 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: Question
about: Ask a question
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 0000000..ba288bd
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,8 @@
+[A clear and concise description of what the pull request is for along with a reference to the associated issue IDs, if they exist.]
+
+## Checklist
+
+* `./mvnw verify` succeeds (if it fails due to code formatting issues reported by Spotless, simply run `spotless:apply` and retry)
+* Changes contain an entry in the `CHANGELOG.adoc`
+* Tests for the changes are provided
+* [Commits are signed](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits) (optional, but highly recommended)
diff --git a/log4j-tools-parent/pom.xml b/log4j-tools-parent/pom.xml
index 8f6e229..671e311 100644
--- a/log4j-tools-parent/pom.xml
+++ b/log4j-tools-parent/pom.xml
@@ -181,6 +181,9 @@
<!-- IntelliJ IDEA files: -->
<exclude>.idea/**/*</exclude>
<exclude>**/*.iml</exclude>
+ <!-- License headers in GitHub templates pollute the prompt displayed to the user: -->
+ <exclude>.github/ISSUE_TEMPLATE/*.md</exclude>
+ <exclude>.github/pull_request_template.md</exclude>
</excludes>
</configuration>
<executions>