Contributing to TDS
In early 2018, the TDS Platform team will be rolling out more robust architecture, tooling, and processes to better scale community component development and contribution.
While we are not looking for direct contributions of new components to the main TDS codebase quite yet, there are many other ways you can contribute, including submission of bug fixes, documentation improvements, and participation in discussions.
That being said, we welcome contributions of enhancements to the currently available components in accordance with the component roadmaps. Check the component documentation to see what is on the roadmap for each one. If you'd like to contribute to any of the available TDS components, follow the steps below.
Expect architectural changes and governance processes to be established soon that will drive a more mature contribution process. Thank you for your patience.
How to contribute
1. Submit an issue
We use Github Issues to track all of our bugs and open discussions so that they are visible to the community.
However, if you would like to make a small adjustment to documentation, you may jump straight to opening a pull request. If you found a bug or would like to begin a conversation, follow these steps:
- Ensure the issue was not already reported by searching the issues
- If you're unable to find an open issue addressing your concern, either:
- Be sure to include a title and clear description, as much relevant information as possible, and - if applicable - a code sample or executable test case demonstrating the expected behaviour that is not occurring
2. Develop a solution
There are different paths to developing a solution depending on your goal:
- Making documentation changes within GitHub: you can make changes to TDS documentation from GitHub without having to write code. You can follow this guide on how to edit files within GitHub. When making commits, be sure to follow the TELUS commit standards. There is no need to create an issue first, you may edit documentation and create a pull request anytime.
- Designers producing assets or symbols: follow the designer guide to contributing Sketch files.
- Developers making changes to components: follow the developer guide to set up your environment for TDS development and read the codebase overview to understand the structure of the codebase and the conventions being followed
3. Make a pull request
First, thanks for taking the time. :)
- Ensure the pull request description clearly describes the problem and the solution. Include the relevant issue number when you submit your pull request
- The TDS Platform team is monitoring for pull requests. We will review your pull request and either merge it, request changes to it, or close it with an explanation