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
|
### 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 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 am not just asking a [question](https://github.com/parse-community/.github/blob/master/SUPPORT.md).
|
||||||
@@ -27,6 +31,16 @@ assignees: ''
|
|||||||
### Expected Outcome
|
### Expected Outcome
|
||||||
<!-- What outcome, for example query result, did you expect? -->
|
<!-- 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
|
### Environment
|
||||||
<!-- Be specific with versions, don't use "latest" or semver ranges like "~x.y.z" or "^x.y.z". -->
|
<!-- 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.**
|
### New Feature / Enhancement Checklist
|
||||||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
<!--
|
||||||
|
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**
|
- [ ] I am not disclosing a [vulnerability](https://github.com/parse-community/parse-server/blob/master/SECURITY.md).
|
||||||
A clear and concise description of what you want to happen.
|
- [ ] 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**
|
### Current Limitation
|
||||||
A clear and concise description of any alternative solutions or features you've considered.
|
<!-- Which current limitation is the feature or enhancement addressing? -->
|
||||||
|
|
||||||
**Additional context**
|
### Feature / Enhancement Description
|
||||||
Add any other context or screenshots about the feature request here.
|
<!-- 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 -->
|
||||||
|
- [ ] ...
|
||||||
@@ -100,7 +100,18 @@ If you want to make changes to [Parse Server Configuration][config] add the desi
|
|||||||
|
|
||||||
To view docs run `npm run docs` and check the `/out` directory.
|
To view docs run `npm run docs` and check the `/out` directory.
|
||||||
|
|
||||||
### Code of Conduct
|
## Feature Considerations
|
||||||
|
### Security Checks
|
||||||
|
|
||||||
|
The Parse Server security checks feature warns developers about weak security settings in their Parse Server deployment.
|
||||||
|
|
||||||
|
A security check needs to be added for every new feature or enhancement that allows the developer to configure it in a way that weakens security mechanisms or exposes functionality which creates a weak spot for malicious attacks. If you are not sure whether your feature or enhancements requires a security check, feel free to ask.
|
||||||
|
|
||||||
|
For example, allowing public read and write to a class may be useful to simplify development but should be disallowed in a production environment.
|
||||||
|
|
||||||
|
Security checks are added in [SecurityChecks.js](https://github.com/parse-community/parse-server/blob/master/src/SecurityChecks.js).
|
||||||
|
|
||||||
|
## Code of Conduct
|
||||||
|
|
||||||
This project adheres to the [Contributor Covenant Code of Conduct](https://github.com/parse-community/parse-server/blob/master/CODE_OF_CONDUCT.md). By participating, you are expected to honor this code.
|
This project adheres to the [Contributor Covenant Code of Conduct](https://github.com/parse-community/parse-server/blob/master/CODE_OF_CONDUCT.md). By participating, you are expected to honor this code.
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user