Why does this exist?
This wiki acts as a source of truth for all the technical knowledge, software specifications, standards and architecture evolution.
This is a collaborative effort to document, track, and discuss digital software standards, tooling and practices, you are welcome to contribute and suggest changes, please follow the contribution guidelines and keep in mind: this repository is Open Source.
Who is this for?
- Existing Team Members: use as a reference, and contribute updates
- New & Future Team Members: learn about our software development standards and practices
- Partners: get familiar with our software standards and practices prior to project delivery commitments
What is the structure?
This is a Public & Open Source repository, with articles written in Markdown denoting various topics in the following categories:
A thin and simple documentation format for technical resources, tools, platforms and decisions. Members can quickly and easily get context on "Why, What & How" for every part of our software standards.
How to take part?
- Focus on Customer First
- Value data over opinions
- Deliver outcomes over outputs
- Take risks and be lean
- Build for quality and reuse
- Be an owner
- Attract and develop leaders
- Embrace inclusivity
- Strengthen communities
Because we love our customers and we love our technology, we are evolving it, in full transparency!
We do all of this in public to truly embrace our customer first principles
In order to achieve this, we ensure no sensitive content is included, such as:
- content considered competitive intelligence
- keys, tokens or credentials
Process & Contribution
A few avenues are made available for ensuring open collaboration and extended support for contributions to this standards wiki:
As a TELUS team member, you are welcome to use The Technology Forum as the official process to guide conversations and discussions around technology solutions, ideas, issue escalation, questions, knowledge sharing, and Reference Architecture evolution.
We keep these two repositories separate, since this one is meant to be public and Open Source, whereas the Technology Forum will involve deep technical discussions and private information.
Simply use GitHub to make new pull-requests, start discussions, and contribute to active ones.
However, if your contribution was not addressed in The Technology Forum the likelihood of adopting your suggested changes is minimal.
All topics MUST follow the format outlined in this this template
Using the GitHub repository itself, rather than the "GitHub Wikis" feature, or other "Wiki" software ensures:
- version tracking, and usage of GitHub GUI features (blame, history, branches, diff, etc ...)
- ability to publish into a static website using GitHub Pages
- leverage branch locking, testing automation and other GitHub features only available in repos
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here.