alamb commented on a change in pull request #17:
URL: https://github.com/apache/arrow-rs/pull/17#discussion_r618373852
##########
File path: .github/ISSUE_TEMPLATE/feature_request.md
##########
@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always
frustrated when [...]
Review comment:
```suggestion
**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*)
```
##########
File path: .github/pull_request_template.md
##########
@@ -0,0 +1,16 @@
+# 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.
+
+Closes #.
+
+# 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.
Review comment:
```suggestion
# 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.
# 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.
```
##########
File path: .github/ISSUE_TEMPLATE/bug_report.md
##########
@@ -0,0 +1,20 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
Review comment:
I like to try and lead people away from a free form description of bugs
as that often ends up more confusing (to me)
What would you think about the sections:
1. To Reproduce
2. Expected Behavior
3. Actual Behavior
4. Additional Context
--
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.
For queries about this service, please contact Infrastructure at:
[email protected]
