Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
✨ Add initial checklistsw
- Loading branch information
Showing
3 changed files
with
67 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,43 @@ | ||
# Code Review Checklist | ||
|
||
### README | ||
|
||
* [ ] Readme includes instructions for running the project locally | ||
|
||
### HTML | ||
|
||
* [ ] Consistent Indentation | ||
* [ ] Includes meta viewport tag for mobile devices | ||
* `<meta name="viewport" content="width=device-width, initial-scale=1.0">` | ||
* [ ] CSS Links and Font Links are in the head of the document | ||
* [ ] JavaScript files are linked at the bottom of the page OR at the top with an onload function OR at the top with a defer attribute | ||
* [ ] Uses semantic tags where available | ||
* header, time, main, nav, article, section etc. | ||
* See this article for more: https://html.com/semantic-markup/ | ||
* [ ] Title / Header links back to home page | ||
* [ ] No extra elements. Only includes the necessary elements to make things work. | ||
|
||
### JavaScript | ||
|
||
* [ ] Consistent semicolon usage. Either do or do not. There is no inbetween. | ||
* [ ] Consistent quote usage. Either `'` or `"`, don't mix. | ||
* [ ] Consistent indentation. | ||
* [ ] Reasonable max line length. Wrap / reformat code when it gets too long. | ||
* [ ] Variable / Function names are clear and concise. | ||
* [ ] No abbreviations. | ||
* [ ] Variable / Function naming convention is consistent. | ||
* camelCase or PascalCase or snake_case | ||
* [ ] Strings used more than once are in a variable. | ||
* API_URL etc. | ||
* [ ] Functions are as few lines as possible. Code reads like a sentence. | ||
* [ ] Function names dictate intent. | ||
* [ ] Nested loops avoided where possible. | ||
* [ ] Functions take in a reasonable number of parameters. Ideally 3 or less params. Otherwise, use an options object. | ||
* [ ] No extra variables. | ||
|
||
### CSS | ||
|
||
* [ ] Consistent indentation | ||
* [ ] Consistent naming convention | ||
* [ ] Uses app specific prefix where necessary | ||
* [ ] No duplicate styles. Re-use where applicable. |
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
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,14 @@ | ||
# UI Review | ||
|
||
* [ ] Fonts choices are consistent | ||
* [ ] Body font is good for reading | ||
* [ ] Loading indicators are shown when there is background processing (API requests, calculations etc.) | ||
* [ ] Page responds nicely to different screen sizes | ||
* [ ] Images resize accordingly | ||
* [ ] Images maintain aspect ratio | ||
* [ ] Columns break at smaller screen sizes | ||
|
||
|
||
# Stretch (Not required, but nice to have) | ||
|
||
* [ ] Elements in a list fade out when leaving and fade in when appearing |