Frontend
Public
Commits
Tim Donohue authored and GitHub committed ecf8e8915f4
| 11 11 | |
| 12 12 | List of changes in this PR: |
| 13 13 | * First, ... |
| 14 14 | * Second, ... |
| 15 15 | |
| 16 16 | **Include guidance for how to test or review your PR.** This may include: steps to reproduce a bug, screenshots or description of a new feature, or reasons behind specific changes. |
| 17 17 | |
| 18 18 | ## Checklist |
| 19 19 | _This checklist provides a reminder of what we are going to look for when reviewing your PR. You need not complete this checklist prior to creating your PR (draft PRs are always welcome). If you are unsure about an item in the checklist, don't hesitate to ask. We're here to help!_ |
| 20 20 | |
| 21 - | - [ ] My PR is small in size (e.g. less than 1,000 lines of code, not including comments & specs/tests). Exceptions may be made if previously agreed upon. |
| 21 + | - [ ] My PR is small in size (e.g. less than 1,000 lines of code, not including comments & specs/tests), or I have provided reasons as to why that's not possible. |
| 22 22 | - [ ] My PR passes [TSLint](https://palantir.github.io/tslint/) validation using `yarn run lint` |
| 23 23 | - [ ] My PR includes [TypeDoc](https://typedoc.org/) comments for _all new (or modified) public methods and classes_. It also includes TypeDoc for large or complex private methods. |
| 24 24 | - [ ] My PR passes all specs/tests and includes new/updated specs for any bug fixes, improvements or new features. A few reminders about what constitutes good tests: |
| 25 25 | * Include tests for different user types (if behavior differs), including: (1) Anonymous user, (2) Logged in user (non-admin), and (3) Administrator. |
| 26 26 | * Include tests for error scenarios, e.g. when errors/warnings should appear (or buttons should be disabled). |
| 27 27 | * For bug fixes, include a test that reproduces the bug and proves it is fixed. For clarity, it may be useful to provide the test in a separate commit from the bug fix. |
| 28 28 | - [ ] If my PR includes new, third-party dependencies (in `package.json`), I've made sure their licenses align with the [DSpace BSD License](https://github.com/DSpace/DSpace/blob/master/LICENSE) based on the [Licensing of Contributions](https://wiki.lyrasis.org/display/DSPACE/Code+Contribution+Guidelines#CodeContributionGuidelines-LicensingofContributions) documentation. |