Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/telus/tds-community

TELUS Design System Community Components
https://github.com/telus/tds-community

component-library components-library css-modules design-system es2015 openshift-dedicated react security-kpi telus telus-community telus-digital web

Last synced: 4 days ago
JSON representation

TELUS Design System Community Components

Awesome Lists containing this project

README 

        
# TELUS Design System Community ![license](https://img.shields.io/github/license/telus/tds-community.svg?style=flat-square)



[![Build Status][circle-image]][circle-url]



The TELUS Design System (TDS) is a set of living guidelines that communicates our brand promise through our digital experiences.

It's a holistic platform that integrates documentation, guidelines and design management that serves as single source for

digital design guidelines, code patterns and UI elements.



## Introduction



The TDS Community is a collaborative platform where TELUS designers and developers can rapidly discover, share, and consume

their modules as part of the TELUS Design System. This includes React components, the [component library for designers](https://tds.telus.com/getting-started/designers.html), and their documentation.



TDS Community is similar to [TDS Core](https://github.com/telus/tds-core) since community components

have the same technical and branding foundations as core components, however the underlying governance model and

maintenance workflow differs. Here is a high level summary:



| Feature               | TDS Core      | TDS Community                |

| --------------------- | ------------- | ---------------------------- |

| Component reusability | High          | Moderate                     |

| Rate of change        | Low           | High                         |

| Contribution speed    | Moderate      | High                         |

| Review board          | TDS Core Team | Digital Platform Ambassadors |



The [Digital Platform Ambassadors](https://github.com/orgs/telus/teams/digital-platform-ambassadors) are a team

of representatives from every tribe at TELUS digital. They help grow the digital platform and will actively

review contributions for the TDS Community to ensure quality standards are met.



## Getting started



Consuming TDS Community Sketch assets or React components is very similar to TDS Core. You can follow our

[getting started](https://tds.telus.com/getting-started/getting-started.html) guide to learn more.



### For designers



During the initial launch of TDS Community, component designs will be audited by internal TELUS design

leads and will be delegated to their respective tribe developers for contribution. These notes will be updated

once an appropriate place for supplementary Sketch assets are decided.



### For developers



Unlike TDS Core, npm modules from TDS Community are prefixed `@tds/community-*`. To set up your project

to consume community or core components:



1.  Follow the [getting started guide for developers](https://tds.telus.com/getting-started/developers.html)

2.  Go to the [TDS Community catalogue](https://tds.telus.com/community/index.html) and choose a component to install



## Contributing



To learn how to make contributions to TDS Community, See the [contributing guide](./.github/CONTRIBUTING.md).



## Further Documentation



- [Background](./guide/history.md)

- [Community governance process](./guide/GovernanceProcess.md)

- [Principles & Guidelines](./guide/PrinciplesGuidelines.md)

- [Why Community](./guide/WhyCommunity.md)

- [TDS Community vs TDS Core](./guide/communityVsCore.md)

- [Digital Platform Ambassadors](./guide/DigitalPlatformAmbassadors.md)

- [How to Guides](./guide/HowToGuides.md)

- [Support](./guide/Support.md)



## Contributors



| [
Marco Donnici](https://github.com/marcod1419)
[](#tds-marcod1419 "") | [
Ryan Oglesby](http://ryanogles.by)
[](#tds-ryanoglesby08 "") | [
Enrico Sacchetti](http://theetrain.ca)
[](#tds-theetrain "") | [
Jack Reeves](https://github.com/jackreeves)
[](#tds-jackreeves "") | [
Jesse David Peterson](http://www.jes.dav.pet)
[](#tds-jesdavpet "") | [
Mujtaba Hasni](https://github.com/mujtabahasni)
[](#tds-mujtabahasni "") | [
Anatolii Gorovyi](https://github.com/agorovyi)
[](#tds-agorovyi "") |

| :---: | :---: | :---: | :---: | :---: | :---: | :---: |

| [
Christina L.](https://github.com/Christina-Lo)
[](#tds-Christina-Lo "") | [
Andrew Lam](https://github.com/Andrew-K-Lam)
[](#tds-Andrew-K-Lam "") | [
Jordan Raffoul](http://jordanraffoul.com)
[](#tds-jraff "") | [
Nicholas Mak](https://github.com/nicmak)
[](#tds-nicmak "") | [
renovate[bot]](https://github.com/apps/renovate)
[](#tds-renovate[bot] "") | [
Mike Bunce](https://github.com/sketchidea)
[](#tds-sketchidea "") | [
Ani](https://github.com/simpleimpulse)
[](#tds-simpleimpulse "") |

| [
Samantha Vale](https://github.com/karlasamantha)
[](#tds-karlasamantha "") | [
Tyler Dewald](https://github.com/DewaldoDev)
[](#tds-DewaldoDev "") | [
Varun Jain](https://github.com/varunj90)
[](#tds-varunj90 "") | [
abdul khan](https://github.com/invalidred)
[](#tds-invalidred "") | [
Nate X](https://github.com/nateriesling)
[](#tds-nateriesling "") | [
Mike Bunce](https://github.com/mike-bunce)
[](#tds-mike-bunce "") | [
Donna Vitan](http://donnavitan.com)
[](#tds-donnavitan "") |

| [
harmeetsaimbhi](https://github.com/harmeetsaimbhi)
[](#tds-harmeetsaimbhi "") | [
Fabio Neves](https://github.com/fzero)
[](#tds-fzero "") | [
Edison Li](https://ca.linkedin.com/in/edison-li)
[](#tds-zyl-edison-telus "") | [
Michelle Linley](https://github.com/meeschka)
[](#tds-meeschka "") | [
Jeffrey Chang](https://github.com/Jeffrey-Chang)
[](#tds-Jeffrey-Chang "") | [
ashwanitelus](https://github.com/ashwanitelus)
[](#tds-ashwanitelus "") | [
Ruchi Jain](https://github.com/ruchijn)
[](#tds-ruchijn "") |

| [
Katherine Szelag](https://github.com/janeszelag)
[](#tds-janeszelag "") |



[circle-url]: https://circleci.com/gh/telus/tds-community

[circle-image]: https://img.shields.io/circleci/project/github/telus/tds-community/master.svg?style=for-the-badge&logo=circleci