To prevent teams from duplicating work and to allow for easier maintenance of our applications, teams may want to create npm libraries to allow for reuse of components or logic. Defining standards and principals behind this type of code reuse will help us to reduce the effort required by teams to use and maintain these libraries.
Teams should consider creating an npm library for reuse across TELUS when:
- There's TELUS-specific logic that we want to share between applications
- There's no existing open source alternative for the problem we're trying to solve
- We're confident that the solution is relatively stable
- Library responsibilities are clear
Any library should:
- Be driven by the needs of the consumer
- Be decoupled from the implementation of the consuming application
- Have easy-to-consume APIs
- Be explicit about dependencies
- Include documentation with example usage
- Follow the versioning strategy defined here
- Include automated tests
- Have clear contribution guidelines
- Use the npm library starter Kit as a starting point.