Engineering Standards Adherence

[arunasank]

Required Elements

If any elements in the below list are not checked, this repo will fail standards compliance.

• Not running node 4 or below
• Has at least some test coverage?
• Has a README?

Rubric

• 1 pt Is in Version Control/Github ✅ (free points)
• 1-2 pt node version:
  • 2 pt Best: running node 8+ 🏅
  • 1 pt Questionable: node 6
• 1 pt CI enabled for repo?
• 1 pt Not running Circle CI version 1? (Point awarded if using Travis)
• 1 pt nyc integrated to show test coverage summary?
• 1-3 pt test coverage percentage from nyc?
  • 3 pt High coverage: > 90%
  • 2 pt Moderate coverage: between 75 and 90% total coverage
  • 1 pt 0 - 74% test coverage
• 1-2 pt evidence of bug fixes/edge cases being tested?
  • 2 pt Strong evidence/several instances noted
  • 1 pt Some evidence - I had a hard time deciding this one
• 1 pt no flags to enable different functionality in non-test environments?
• 1 pt Has README?
• 1 pt Has CHANGELOG?
• 1-2 pt README explains purpose of a project and how it works to some detail?
  • 2 pt High (but appropriate) amount of detail about the project
  • 1 pt Some detail about the project documented, could be more extensive
• 1 pt README contains deploy/publish/install instructions?
• 1 pt README contains CI badges, as appropriate?
• 1-2 pt Code seems self-documenting: file/module names, function names, variables? No redundant comments to explain naming conventions?
  • 2 pt Strongly self-documented code, little to no improvements needed
  • 1 pt Some evidence of self-documenting code
• 1 pt No potential security vulnerabilities are reported in dependencies?
• 1 pt Package is scoped to @mapbox on NPM?
• 1-2 pt master branch protected?
  • 1 pt PRs can only be merged if tests are passing?
  • 1 pt PRs must be approved before merging?
• 2 pt BONUS: was this repo covered in a deep dive at some point? (part of bench, so, going to award points for that!)

Total possible: 24 points (+2 bonus)
Grading scale:

Point Total	Qualitative Description	Scaled Grade
20+ points	Strongly adheres to eng. standards	5
16-19 points	Adheres to eng. standards fairly well	4
12-15 points	Adheres to some eng. standards	3
8-11 points	Starting to adhere to some eng. standards	2
4-7 points	Following a limited number of eng. standard practices	1
< 4 points	Needs significant work, does not follow most standards	0

Repo grade: 15/24. Grade 3 (2018-08-08)

cc/ @mapbox/sreious-business