Improve issue templates & add PR template (#7051)
* improved feature suggestion template * added test case chapter to bug report template * PR wording * added PR template * improved formatting in issue template * removed checkbox for concept due to new GH discussions process * improved wording * improved PR todo list * amended PR checklist; minor rewording * removed duplicate wording * add securtiy check section to contribution guide
This commit is contained in:
16
.github/ISSUE_TEMPLATE/---1-report-an-issue.md
vendored
16
.github/ISSUE_TEMPLATE/---1-report-an-issue.md
vendored
@@ -8,7 +8,11 @@ assignees: ''
|
||||
---
|
||||
|
||||
### New Issue Checklist
|
||||
<!-- Please check the following boxes [ ] -> [x] before submitting your issue. Click the "Preview" tab for better readability. Thanks for reporting issues back to Parse Server! -->
|
||||
<!--
|
||||
Please check the following boxes [x] before submitting your issue.
|
||||
Click the "Preview" tab for better readability.
|
||||
Thanks for contributing to Parse Server!
|
||||
-->
|
||||
|
||||
- [ ] I am not disclosing a [vulnerability](https://github.com/parse-community/parse-server/blob/master/SECURITY.md).
|
||||
- [ ] I am not just asking a [question](https://github.com/parse-community/.github/blob/master/SUPPORT.md).
|
||||
@@ -27,6 +31,16 @@ assignees: ''
|
||||
### Expected Outcome
|
||||
<!-- What outcome, for example query result, did you expect? -->
|
||||
|
||||
### Failing Test Case / Pull Request
|
||||
<!--
|
||||
Check one of the following boxes [x] if you added a PR and add the link.
|
||||
See the contribution guide for how add a test cases:
|
||||
https://github.com/parse-community/parse-server/blob/master/CONTRIBUTING.md
|
||||
-->
|
||||
|
||||
- [ ] 🤩 I submitted a PR with a fix and a test case.
|
||||
- [ ] 🧐 I submitted a PR with a failing test case.
|
||||
|
||||
### Environment
|
||||
<!-- Be specific with versions, don't use "latest" or semver ranges like "~x.y.z" or "^x.y.z". -->
|
||||
|
||||
|
||||
30
.github/ISSUE_TEMPLATE/---2-feature-request.md
vendored
30
.github/ISSUE_TEMPLATE/---2-feature-request.md
vendored
@@ -7,14 +7,28 @@ 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 [...]
|
||||
### New Feature / Enhancement Checklist
|
||||
<!--
|
||||
Please check the following boxes [x] before submitting your issue.
|
||||
Click the "Preview" tab for better readability.
|
||||
Thanks for contributing to Parse Server!
|
||||
-->
|
||||
|
||||
**Describe the solution you'd like**
|
||||
A clear and concise description of what you want to happen.
|
||||
- [ ] I am not disclosing a [vulnerability](https://github.com/parse-community/parse-server/blob/master/SECURITY.md).
|
||||
- [ ] I am not just asking a [question](https://github.com/parse-community/.github/blob/master/SUPPORT.md).
|
||||
- [ ] I have searched through [existing issues](https://github.com/parse-community/parse-server/issues?q=is%3Aissue).
|
||||
|
||||
**Describe alternatives you've considered**
|
||||
A clear and concise description of any alternative solutions or features you've considered.
|
||||
### Current Limitation
|
||||
<!-- Which current limitation is the feature or enhancement addressing? -->
|
||||
|
||||
**Additional context**
|
||||
Add any other context or screenshots about the feature request here.
|
||||
### Feature / Enhancement Description
|
||||
<!-- What is the concept of the functionality and how should it be implemented? -->
|
||||
|
||||
### Example Use Case
|
||||
<!-- What is an example use case in steps (1. / 2. / 3. / etc.) that describes the functionality? -->
|
||||
|
||||
### Alternatives / Workarounds
|
||||
<!-- Which alternatives or workarounds exist currently? -->
|
||||
|
||||
### 3rd Party References
|
||||
<!-- Have you seen a similar functionality provided somewhere else? -->
|
||||
30
.github/PULL_REQUEST_TEMPLATE/pull_request_template.md
vendored
Normal file
30
.github/PULL_REQUEST_TEMPLATE/pull_request_template.md
vendored
Normal file
@@ -0,0 +1,30 @@
|
||||
### New Pull Request Checklist
|
||||
<!--
|
||||
Please check the following boxes [x] before submitting your issue.
|
||||
Click the "Preview" tab for better readability.
|
||||
Thanks for contributing to Parse Server!
|
||||
-->
|
||||
|
||||
- [ ] I am not disclosing a [vulnerability](https://github.com/parse-community/parse-server/blob/master/SECURITY.md).
|
||||
- [ ] I am creating this PR in reference to an [issue](https://github.com/parse-community/parse-server/issues?q=is%3Aissue).
|
||||
|
||||
### Issue Description
|
||||
<!-- Add a brief description of the issue this PR solves. -->
|
||||
|
||||
Related issue: FILL_THIS_OUT
|
||||
|
||||
### Approach
|
||||
<!-- Add a description of the approach in this PR. -->
|
||||
|
||||
### TODOs before merging
|
||||
<!--
|
||||
Add TODOs that need to be completed before merging this PR.
|
||||
Delete suggested TODOs that do not apply to this PR.
|
||||
-->
|
||||
|
||||
- [ ] Add test cases
|
||||
- [ ] Add entry to changelog
|
||||
- [ ] Add changes to documentation (guides, repository pages, in-code descriptions)
|
||||
- [ ] Add [security check](https://github.com/parse-community/parse-server/blob/master/CONTRIBUTING.md#security-checks)
|
||||
- [ ] Add new Parse Error codes to Parse JS SDK <!-- no hard-coded error codes in Parse Server -->
|
||||
- [ ] ...
|
||||
Reference in New Issue
Block a user