-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into UIDATIMP-690
- Loading branch information
Showing
1 changed file
with
69 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| <!-- | ||
| If you have a relevant JIRA issue number, please put it in the issue title. | ||
| Example: UIDATIMP-630: Refine an identifier matching for Instances | ||
| --> | ||
|
|
||
| ## Purpose | ||
| <!-- | ||
| Why are you making this change? There is nothing more important | ||
| to provide to the reviewer and to future readers than the cause | ||
| that gave rise to this pull request. Be careful to avoid circular | ||
| statements like "the purpose is to change the font colors." and | ||
| instead provide an explanation like "the current textual color palette | ||
| does not provide enough contrast for certain classes of visual impairments." | ||
| The purpose may seem self-evident to you now, but the standard to | ||
| hold yourself to should be "can a developer parachuting into this | ||
| project reconstruct the necessary context merely by reading this | ||
| section." | ||
| --> | ||
|
|
||
| ## Approach | ||
| <!-- | ||
| How does this change fulfill the purpose? It's best to talk | ||
| high-level strategy and avoid code-splaining the commit history. | ||
| Bad: | ||
| Made a dark color of #333, a medium color of #ccc | ||
| Good: | ||
| This introduces three abstract contrast levels that developers can | ||
| use: dark, medium, and light. | ||
| The goal is not only to explain what you did, but help other | ||
| developers *work* with your solution in the future. | ||
| --> | ||
|
|
||
| <!-- OPTIONAL | ||
| #### TODOS and Open Questions | ||
| - [ ] Use GitHub checklists. When solved, check the box and explain the answer. | ||
| --> | ||
|
|
||
| <!-- OPTIONAL | ||
| ## Learning | ||
| Help out not only your reviewer, but also your fellow developer! | ||
| Sometimes there are key pieces of information that you used to come up | ||
| with your solution. Don't let all that hard work go to waste! A | ||
| pull request is a *perfect opportunity to share the learning that | ||
| you did. Add links to blog posts, patterns, libraries or addons used | ||
| to solve this problem. | ||
| --> | ||
|
|
||
| ## Refs | ||
| <!-- | ||
| If you have a relevant JIRA issue, add a link directly to the issue URL here. | ||
| Example: https://issues.folio.org/browse/UIDATIMP-630 | ||
| --> | ||
|
|
||
| ## Screenshots | ||
| <!-- OPTIONAL | ||
| One picture is literally worth a thousand words. When the feature is | ||
| an interaction, an animated GIF is best. Most of the time it helps to | ||
| include "before" and "after" screenshots to quickly demonstrate the | ||
| value of the feature. | ||
| Here are some great tools to help you record gifs: | ||
| Windows: https://getsharex.com/ | ||
| Mac: https://gifox.io/ | ||
| --> |