Skip to content

Developer guide: dev site acceptance criteria

cgolubi1 edited this page Apr 6, 2018 · 7 revisions

This page documents the acceptance criteria for a pull request to be accepted into the "dev" branch and loaded onto dev.buttonweavers.com:

  • The pull must be from a feature branch in an individual contributor's buttonmen repo
  • The pull must be to buttonmen-dev:master
  • The initial pull should contain a single commit for ease of reverting (rebase it until this is the case) --- later commits to the same branch should not be rebased until dev-site testing is complete
  • The pull must contain a link to a passing CircleCI run with the correct commit ID
  • The code must follow our basic high-level layout of what code goes in what directories
  • The pull must not remove test code (if there is a need to remove test code, the code will have to be more carefully reviewed)
  • If the pull adds significant code, the pull must add enough tests to keep PHP and JS code coverage percentages at their previous level
  • If the pull contains database changes, the changes must apply identically to fresh DB loads and to DB updates (the reviewer should do an update-vs-reload test to verify this)
  • The code must not contain anything so offensive we are unwilling to have it in our codebase (this is necessarily subjective, and hopefully unlikely to come up)

Special cases:

  • If a pull is found to break dev site functionality, the fix must add test code which reproduces the regression, in addition to the fix

Clone this wiki locally