Update wrapper description text #137
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull request template - for feature branches
A feature branch should make edits/additions to a single component, or limited collection of closely connected components.
Previous pull request for this component or collection of closely connected components should be detailed in the table below.
Previous pull requests:
For any updated component, the developer should consider whether to update the component's status (it's main status tag and tick/cross sub-statuses on the wrapper page). A component's status should be updated when it is ready for a particular type of review. The reviewer will then tailor their review accordingly (e.g. if a component's sub-statuses is updated to include accessible, the reviewer will then test it against our accessibility checklist).
Definitions of each component status can be found on the library's component statuses page.
Updated components:
FalseWhen a component is created, its description and context should be added to the wrapper page. They should then be added to the table below.
For each following pull request, the developer must evaluate whether either of the description or context need to be amended or added to. If a change is made, the developer should detail in the table below to help the reviewer understand what changes have been made to how the component functions or is being used.
Updated component information:
Changes to a component often create a necessity for changes to a connected component. Developer's should check connected components and then detail any changes to the ways in which component interact with each other in the table below.
Connected components for checking:
Any new dependencies to external packages should be detailed in the table below. Reviewers can then check that this dependency is necessary and is the best approach.
New dependencies:
The table below should list out the core features added as part of this pull request. This helps the reviewer understand the justifications for major changes.
Core features added:
The table below encourages the developer to direct the reviewer towards specific checks (e.g. parts of their code where they're unsure whether they did it in the best way, or if they'd appreciate extra testing that behaviour is as expected).
Requested checks:
Developers are encouraged to write any further notes below which they think could be helpful to the reviewer.
Additional notes: