Code/Development Standards

Web development standards/best practices will be developed to help ensure that code is consistent, maintainable, and sustainable.

  • Code additions should be developed on separate branches so that work can be integrated into the mainline of development incrementally (“feature branches”.)
  • Code reviews will be conducted on student work and periodic staff work
  • Testing (incl testing for accessibility) - working on developing automated tests, where applicable
  • Students will be trained on standards used by Web Services
    • For WordPress, configuration files exist for eslint (Javascript formatting standards), stylelint (CSS formating standards), and PHP (PHP formatting standards for WordPress). Developer tools should be configured to respect these rules so that code can be committed “cleanly”
    • Configurations similar to the above should be used in other environments (Node.js, PHP outside of WordPress, etc...)
  • Standards should be reviewed and updated annually