Skip to content

Code: Quality Expectations #205

@pfulton

Description

@pfulton

This chunk of documentation was in the Build Process README, but it doesn't feel like it belongs there, especially due to the most recent rewrites and updates.

We should probably update this and relocate it elsewhere. Capturing the original stuff here for posterity:


Quality Expectations

There are certain things we expect to happen frequently to help keep quality
visible to our team and clients.

  • Performance Budgets: Performance budgets are captured early, and
    performance is tracked automatically. Trends are as important as limits.
  • Style: We seek consistency in code structure and style within a project.
    We expect that how we structure Sass, JavaScript, Ruby, HTML, etc., will
    change over time as we learn. Those choices we make on a project should be
    codified with tools like [jshint], [stylelint], [Code Climate], etc.
  • Tests: We configure every project to support automated tests. In
    most cases, this means [Jasmine], Mocha, Rspec, Minitest, etc. These tests
    are easy to run locally, preferrably when code changes. All tests
    run using [CircleCI], reporting results to pull requests.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions