diff --git a/.github/ISSUE_TEMPLATE/---1-report-an-issue.md b/.github/ISSUE_TEMPLATE/---1-report-an-issue.md index dbfa97106a..44c2cc7f55 100644 --- a/.github/ISSUE_TEMPLATE/---1-report-an-issue.md +++ b/.github/ISSUE_TEMPLATE/---1-report-an-issue.md @@ -8,7 +8,11 @@ assignees: '' --- ### New Issue Checklist - + - [ ] 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 +### Failing Test Case / Pull Request + + +- [ ] 🤩 I submitted a PR with a fix and a test case. +- [ ] 🧐 I submitted a PR with a failing test case. + ### Environment diff --git a/.github/ISSUE_TEMPLATE/---2-feature-request.md b/.github/ISSUE_TEMPLATE/---2-feature-request.md index c2756fb952..282e9e7a12 100644 --- a/.github/ISSUE_TEMPLATE/---2-feature-request.md +++ b/.github/ISSUE_TEMPLATE/---2-feature-request.md @@ -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 + -**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 + -**Additional context** -Add any other context or screenshots about the feature request here. +### Feature / Enhancement Description + + +### Example Use Case + + +### Alternatives / Workarounds + + +### 3rd Party References + \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md new file mode 100644 index 0000000000..f7b9b13f1a --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -0,0 +1,30 @@ +### New Pull Request Checklist + + +- [ ] 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 + + +Related issue: FILL_THIS_OUT + +### Approach + + +### TODOs before merging + + +- [ ] 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 newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bc7279af93..6c2ccd3bd8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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. -### 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.