Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Code: Quality Expectations #205

Open
pfulton opened this issue Dec 3, 2019 · 0 comments
Open

Code: Quality Expectations #205

pfulton opened this issue Dec 3, 2019 · 0 comments

Comments

@pfulton
Copy link
Contributor

pfulton commented Dec 3, 2019

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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant