|
| 1 | +**Description** |
| 2 | +A description of the PR, should include a decent explanation as to why this change was needed and a decent explanation as to what this change does |
| 3 | + |
| 4 | +**Review Instructions** |
| 5 | +Describe if this ticket needs review and if so, how one may go about it in qa and/or staging environments. |
| 6 | +For example, a ticket based on Security Hub, Snyk, or Dependabot may not need review since those services |
| 7 | +will generate new warnings if the issue has not been resolved properly. On the other hand, an infrastructure |
| 8 | +ticket that results in visible changes to the end-user will definitely require review. |
| 9 | +Many tickets will likely be between these two extremes, so some judgement may be required. |
| 10 | + |
| 11 | +**Issue** |
| 12 | +A link to a github issue or SEAB- ticket (using that as a prefix) |
| 13 | + |
| 14 | +**Security and Privacy** |
| 15 | + |
| 16 | +If there are any concerns that require extra attention from the security team, highlight them here. |
| 17 | + |
| 18 | +e.g. Does this change... |
| 19 | +* Any user data we collect, or data location? |
| 20 | +* Access control, authentication or authorization? |
| 21 | +* Encryption features? |
| 22 | + |
| 23 | +Please make sure that you've checked the following before submitting your pull request. Thanks! |
| 24 | + |
| 25 | +- [ ] Check that you pass the basic style checks and unit tests by running `mvn clean install` |
| 26 | +- [ ] Ensure that the PR targets the correct branch. Check the milestone or fix version of the ticket. |
| 27 | +- [ ] Follow the existing JPA patterns for queries, using named parameters, to avoid SQL injection |
| 28 | +- [ ] If you are changing dependencies, check the Snyk status check or the dashboard to ensure you are not introducing new high/critical vulnerabilities |
| 29 | +- [ ] Assume that inputs to the API can be malicious, and sanitize and/or check for Denial of Service type values, e.g., massive sizes |
| 30 | +- [ ] Do not serve user-uploaded binary images through the Dockstore API |
| 31 | +- [ ] Ensure that endpoints that only allow privileged access enforce that with the `@RolesAllowed` annotation |
| 32 | +- [ ] Do not create cookies, although this may change in the future |
| 33 | +- [ ] If this PR is for a user-facing feature, create and link a documentation ticket for this feature (usually in the same milestone as the linked issue). Style points if you create a documentation PR directly and link that instead. |
0 commit comments