This is an automated email from the ASF dual-hosted git repository.
alamb pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/arrow-rs.git
The following commit(s) were added to refs/heads/master by this push:
new a2f7fb9f8 Comment out help text in issue templates (#2196)
a2f7fb9f8 is described below
commit a2f7fb9f82ccb91a9f5670d25c343dfbe194dee3
Author: Raphael Taylor-Davies <[email protected]>
AuthorDate: Wed Jul 27 18:00:41 2022 +0100
Comment out help text in issue templates (#2196)
---
.github/ISSUE_TEMPLATE/bug_report.md | 8 ++++++++
.github/ISSUE_TEMPLATE/feature_request.md | 8 ++++++++
.github/ISSUE_TEMPLATE/question.md | 6 ++++++
.github/pull_request_template.md | 12 ++++++------
4 files changed, 28 insertions(+), 6 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md
b/.github/ISSUE_TEMPLATE/bug_report.md
index 5600dab98..c2b7d626d 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -8,13 +8,21 @@ assignees: ''
---
**Describe the bug**
+<!--
A clear and concise description of what the bug is.
+-->
**To Reproduce**
+<!--
Steps to reproduce the behavior:
+-->
**Expected behavior**
+<!--
A clear and concise description of what you expected to happen.
+-->
**Additional context**
+<!--
Add any other context about the problem here.
+-->
\ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md
b/.github/ISSUE_TEMPLATE/feature_request.md
index d9883dd45..d7aad5e77 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -8,14 +8,22 @@ assignees: ''
---
**Is your feature request related to a problem or challenge? Please describe
what you are trying to do.**
+<!--
A clear and concise description of what the problem is. Ex. I'm always
frustrated when [...]
(This section helps Arrow developers understand the context and *why* for this
feature, in addition to the *what*)
+-->
**Describe the solution you'd like**
+<!--
A clear and concise description of what you want to happen.
+-->
**Describe alternatives you've considered**
+<!--
A clear and concise description of any alternative solutions or features
you've considered.
+-->
**Additional context**
+<!--
Add any other context or screenshots about the feature request here.
+-->
diff --git a/.github/ISSUE_TEMPLATE/question.md
b/.github/ISSUE_TEMPLATE/question.md
index 75c730804..aafac7cb8 100644
--- a/.github/ISSUE_TEMPLATE/question.md
+++ b/.github/ISSUE_TEMPLATE/question.md
@@ -8,10 +8,16 @@ assignees: ''
---
**Which part is this question about**
+<!--
Is it code base, library api, documentation or some other part?
+-->
**Describe your question**
+<!--
A clear and concise description of what the question is.
+-->
**Additional context**
+<!--
Add any other context about the problem here.
+-->
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index db170e360..7c51452c5 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -1,6 +1,6 @@
# Which issue does this PR close?
-<!---
+<!--
We generally require a GitHub issue to be filed for all bug fixes and
enhancements and this helps us generate change logs for our releases. You can
link an issue to this PR using the GitHub syntax. For example `Closes #123`
indicates that this PR will close issue #123.
-->
@@ -8,21 +8,21 @@ Closes #.
# Rationale for this change
- <!---
- Why are you proposing this change? If this is already explained clearly in
the issue then this section is not needed.
- Explaining clearly why changes are proposed helps reviewers understand your
changes and offer better suggestions for fixes.
+<!--
+Why are you proposing this change? If this is already explained clearly in the
issue then this section is not needed.
+Explaining clearly why changes are proposed helps reviewers understand your
changes and offer better suggestions for fixes.
-->
# What changes are included in this PR?
-<!---
+<!--
There is no need to duplicate the description in the issue here but it is
sometimes worth providing a summary of the individual changes in this PR.
-->
# Are there any user-facing changes?
-<!---
+<!--
If there are user-facing changes then we may require documentation to be
updated before approving the PR.
-->
