|
2 | 2 |
|
3 | 3 | Describe what this pull request changes, and why. Include implications for people using this change.
|
4 | 4 | Design decisions and their rationales should be documented in the repo (docstring / ADR), per
|
| 5 | +[OEP-19](https://open-edx-proposals.readthedocs.io/en/latest/oep-0019-bp-developer-documentation.html), and can be linked here. |
5 | 6 |
|
6 | 7 | Useful information to include:
|
7 |
| -- Which edX user roles will this change impact? Common user roles are "Learner", "Course Author", |
| 8 | +- Which user roles will this change impact? Common user roles are "Learner", "Course Author", |
8 | 9 | "Developer", and "Operator".
|
9 | 10 | - Include screenshots for changes to the UI (ideally, both "before" and "after" screenshots, if applicable).
|
10 |
| -- Provide links to the description of corresponding configuration changes. Remember to correctly annotate these |
11 |
| -changes. |
12 | 11 |
|
13 | 12 | ## Supporting information
|
14 | 13 |
|
15 |
| -Link to other information about the change, such as Jira issues, GitHub issues, or Discourse discussions. |
| 14 | +Link to other information about the change, such as GitHub issues, or Discourse discussions. |
16 | 15 | Be sure to check they are publicly readable, or if not, repeat the information here.
|
17 | 16 |
|
18 | 17 | ## Testing instructions
|
19 | 18 |
|
20 |
| -Please provide detailed step-by-step instructions for testing this change. |
21 |
| - |
| 19 | +Please provide detailed step-by-step instructions for manually testing this change. |
22 | 20 |
|
23 | 21 | ## Other information
|
24 | 22 |
|
25 | 23 | Include anything else that will help reviewers and consumers understand the change.
|
26 | 24 | - Does this change depend on other changes elsewhere?
|
27 |
| -- Any special concerns or limitations? For example: deprecations, migrations, security, or accessibility. |
| 25 | +- Any special concerns or limitations? For example: deprecations, migrations, security, or accessibility. |
| 26 | + |
| 27 | +## Best Practices Checklist |
| 28 | + |
| 29 | +We're trying to move away from some deprecated patterns in this codebase. Please |
| 30 | +check if your PR meets these recommendations before asking for a review: |
| 31 | + |
| 32 | +- [ ] Any _new_ files are using TypeScript (`.ts`, `.tsx`). |
| 33 | +- [ ] Deprecated `propTypes`, `defaultProps`, and `injectIntl` patterns are not used in any new or modified code. |
| 34 | +- [ ] Tests should use the helpers in `src/testUtils.tsx` (specifically `initializeMocks`) |
| 35 | +- [ ] Do not add new fields to the Redux state/store. Use React Context to share state among multiple components. |
| 36 | +- [ ] Use React Query to load data from REST APIs. See any `apiHooks.ts` in this repo for examples. |
| 37 | +- [ ] All new i18n messages in `messages.ts` files have a `description` for translators to use. |
| 38 | +- [ ] Imports avoid using `../`. To import from parent folders, use `@src`, e.g. `import { initializeMocks } from '@src/testUtils';` instead of `from '../../../../testUtils'` |
0 commit comments