Skip to content

best-practices

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

best-practices

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
documentation
documentation
 
 
2FA.md
2FA.md
 
 
README.md
README.md
 
 
ai_coding_tools.md
ai_coding_tools.md
 
 
automating_deployment_notifications.md
automating_deployment_notifications.md
 
 
background_processing.md
background_processing.md
 
 
communication.md
communication.md
 
 
db_reset.md
db_reset.md
 
 
deploying_maintaining_aws.md
deploying_maintaining_aws.md
 
 
deprecation.md
deprecation.md
 
 
environments.md
environments.md
 
 
folio_sdr_integrations.md
folio_sdr_integrations.md
 
 
howto_readme.md
howto_readme.md
 
 
infra-accessibility.md
infra-accessibility.md
 
 
javascript_debugging.md
javascript_debugging.md
 
 
kafka.md
kafka.md
 
 
licensing.md
licensing.md
 
 
monitoring.md
monitoring.md
 
 
pair_programming.md
pair_programming.md
 
 
puppet_prs.md
puppet_prs.md
 
 
releasing_gems.md
releasing_gems.md
 
 
robots_txt.md
robots_txt.md
 
 
setting_up_ruby_projects.md
setting_up_ruby_projects.md
 
 
shared_configs.md
shared_configs.md
 
 
solr.md
solr.md
 
 
ssh_configuration.md
ssh_configuration.md
 
 
testing.md
testing.md
 
 
ticket_writing.md
ticket_writing.md
 
 
ui_bootstrap.md
ui_bootstrap.md
 
 
updating-nodejs.md
updating-nodejs.md
 
 
updating-ruby.md
updating-ruby.md
 
 
version_control.md
version_control.md
 
 

README.md

Best Practices

Best practices guides should attempt to answer the question:

To what extent does it make our products better?

  • Easier to develop
  • Easier to test
  • Easier to deploy
  • Easier to maintain
  • Easier to understand by a new developer that has to get up to speed with the code

Or conversely, what is the level of danger if we don't agree and everyone does it differently?

Best practices should represent existing or emerging consensus within the department. Where possible, best practices should refer to open source documentation for further information and, especially, any useful getting started guides.

Best practices should also be generally applicable, and describe a high level of practice (so that, they too, are easier to develop, deploy, maintain and learn).