standards.md

tech-standards

Discuss here on how to adopt new technology standards w/ examples

Current Standards

View the Current Standards.

Process

Depending on the impact of the technology on production or team productivity, we can have:

1. small to no impact
2. substantial impact

1. Small to no impact

• try it, ideally on a small portion of the code base
• do a knowledge sharing to showcase the technology in the TES ecosystem

2. Substantial impact

Create a proposal

• create a new issue
• be sure to include the technology name clearly in the issue title
• follow the issue template as closely as is reasonable
• invite team members to discuss!

Knowledge sharing [optional]

The purpose of this knowledge sharing is to showcase the technology and eventually get people on board

Resolve proposals

• no formal rules, but modest consensus for adoption is the goal
• close issue when consensus is reached
• label issue with standard or rejected tag
• if this replaces a previous technology, label the previous issue as deprecated

Adopt proposals

If you adopt the new technology in your project, please link back the issue so others can see how the migration has been done.

Knowledge sharing

The purpose of this knowledge sharing is to showcase the technology in the TES ecosystem

State of the stack

Aspirationally, viewing closed issues labelled standard should give us a reasonably accurate view of our stack.

Voting on a technology

When there is no general consensus on a technology (e.g. request library), we will vote and, after 2 weeks, the technology will become a new standard

New Standard Adoption

When a new standard is adopted a few actions should take place:

1. 5-minute knowledge sharing on the new technology
2. send an email to all project parents to let them know of the new standard
3. add this information to the engineering git book
4. add the technology to the standards document