Skip to content
Permalink
Browse files

Add initial checklistsw

  • Loading branch information
w3cj committed Nov 26, 2019
1 parent ec06556 commit 4df2f4fe19adc2ef501a2dd7b07d6507435bb565
Showing with 67 additions and 0 deletions.
  1. +43 −0 CODE_REVIEW_CHECKLIST.md
  2. +10 −0 README.md
  3. +14 −0 UI_REVIEW.md
@@ -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.
@@ -92,6 +92,8 @@ Your website should have 2 HTML pages.
* Waiting for Code Review
* Waiting for Feedback

> See the [Code Review Checklist](./CODE_REVIEW_CHECKLIST.md) and [UI Review Checklist](./UI_REVIEW.md) to know what I'll be looking for.
## Example 3rd party web APIs to use

> NOTE: you will want to find an API that does not require OAuth / authentication, and is completely open or only requires an API key.
@@ -175,3 +177,11 @@ Not required, but if you want to go above and beyond:
## TODO: (For CJ on stream)

* [ ] Create an Overall Project Rubric to use for consistent reviews and self guidance
* [ ] How to submit a project
* [ ] HTTP
* [ ] 3rd party web apis
* [ ] How to turn a wireframe into a layout using a css framework
* [ ] Choosing an web API and reading / understanding the documentation
* [ ] Make an api request and add the data to the DOM
* [ ] What is CORS and how to work within its constraints
* [ ] How to create a github repo to participate
@@ -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

0 comments on commit 4df2f4f

Please sign in to comment.
You can’t perform that action at this time.