QA Guide

[jc2820]

G2H QA Guide

Code Quality

• Team to use prettier to ensure neat code.
  • Compare and uniform configs to avoid merge issues.
• Use ESLint default config for React apps.
• Double quotes (specified in linter config).
• Use ES6 syntax everywhere.
• PascalCase for React components, files and folders.
• camelCase for non-React variables.
• Empty tags not divs as component wrappers. Use divs only for low-key box layout.
• Use semantic and accessible HTML with styled-components - Nav, header, section, article, footer etc.
• A folder for each component.
• App.js, App.style.js, App.test.js.
• Remove old logs and comments before committing.
• Capitalise first letter of commit messages.
• Co-author commits when relevant.
• Use Relates in commit messages - don't use Closes.
• Branches named feature/fix/test/refactor__branch-description
• Keep code readable.
• DRY - use shared/pure functions and state if possible.
• Use meaningful and clear variable names - no single letters.

Testing

• Jest and React Testing Library.
• Codecov for coverage.
• Travis CI.
• Meaningful TDD where possible.
• Aim to test all components and mock DB calls.
• Don't spend forever on a complex test if it becomes a blocker.