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/16 19:33:53 UTC
[logging-log4j2] branch release-2.x updated: Add GitHub Issue and Pull Request templates

This is an automated email from the ASF dual-hosted git repository.

vy pushed a commit to branch release-2.x
in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git


The following commit(s) were added to refs/heads/release-2.x by this push:
     new c6019c979a Add GitHub Issue and Pull Request templates
c6019c979a is described below

commit c6019c979ac07c1e664d066d01302561b47d2c72
Author: Volkan Yazıcı <vo...@yazi.ci>
AuthorDate: Mon Jan 16 20:34:57 2023 +0100

    Add GitHub Issue and Pull Request templates
---
 .github/ISSUE_TEMPLATE/bug_report.md      | 42 +++++++++++++++++++++++++++++++
 .github/ISSUE_TEMPLATE/feature_request.md | 24 ++++++++++++++++++
 .github/ISSUE_TEMPLATE/question.md        | 23 +++++++++++++++++
 .github/pull_request_template.md          | 23 +++++++++++++++++
 4 files changed, 112 insertions(+)

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 0000000000..e8cd74467f
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,42 @@
+# 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: Bug report
+about: Submit a bug report
+---
+
+## Description
+
+&lsqb;A clear and concise description of what the bug is.&rsqb;
+
+## Configuration
+
+**Version:** &lsqb;Log4j version&rsqb;
+
+**Operating system:** &lsqb;OS and version&rsqb;
+
+**JDK:** &lsqb;JDK distribution and version&rsqb;
+
+## Logs
+
+```
+[Stacktraces, errors, etc. relevant applications logs.]
+```
+
+## Reproduction
+
+&lsqb;An isolated test reproducing the test.
+JUnit tests similar to the ones in the code base are extremely appreciated.&rsqb;
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 0000000000..d015abe908
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,24 @@
+# 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
+about: Submit a feature request
+---
+
+**Warning!**
+It is highly recommended to discuss feature requests in [the mailing lists](https://logging.apache.org/log4j/2.x/support.html) first.
+
+&lsqb;A clear and concise description of feature requested.&rsqb;
diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md
new file mode 100644
index 0000000000..f64cccd16f
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/question.md
@@ -0,0 +1,23 @@
+# 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
+---
+
+As clearly indicated in [the Log4j support page](https://logging.apache.org/log4j/2.x/support.html#issues), **please use mailing lists for questions!**
+
+Issues asking questions will be removed, and you will be asked to post questions to the mailing lists instead.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 0000000000..35513048cb
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,23 @@
+# 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.
+
+&lsqb;A clear and concise description of what the pull request is for along with a reference to the associated issue IDs, if they exist.&rsqb;
+
+## Checklist
+
+* `./mvnw verify` succeeds
+* Changes contain an entry file in the `src/changelog/.2.x.x` directory
+* 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)