Skip to main content

Contribute to Allium

All kinds of contributions are welcome, from adding your perspective to discussions, editing documentation, sharing design explorations, to submitting coded solutions. There are many ways you can contribute to Allium using your skills and available time.

Ways to contribute​

  1. Report a bug and give feedback
  2. Edit documentation
  3. Contribute a new component or feature
  4. Request a new icon
  5. Participate in discussions as part of the Digital Platform Ambassadors

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 all consumers of the design system.

  1. Make sure the issue isn't already reported by searching the issues
    • If you find an issue that addresses the problem you're having, please add your own reproduction information to the existing issue rather than creating a new one
    • Adding a reaction can also help indicate to our maintainers that a particular problem is affecting more than just the reporter.
  2. If you can't find an open issue addressing your concern, you can submit a new issue:
  3. When you create a new issue, a template will be loaded that will ask you for any relevant information
    • Make sure to include a short title, a clear description, and any helpful information such as screenshots and other resources
    • When reporting a bug, please provide code sample or executable test case demonstrating the expected behaviour that is not occurring

Key considerations when creating issues:

  • Issues that may affect multiple sales and service teams
    • Join the #dpa-community Slack channel to connect with the community and participate in discussions
  • Issues that may affect multiple brands

Learn how to open an issue on GitHub.

2. Contribute a solution​

There are many paths to contributing a solution. Straightforward solutions can be developed and submitted with a pull request, such as updates to the documentation website. More complex solutions may require further discussion with the team and collaboration with the community.

  1. Update the documentation website
    • Use the GitHub interface or develop in your local environment
    • 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
    • Follow the guide to edit documentation
  2. Create design assets or symbols
    • Follow the designer's guide to set up your Figma workspace
    • Read the design foundations and apply them to your designs
    • Share links to your designs and prototypes
    • Export assets and add them to the relevant Github issue
  3. Develop changes to components
    • Follow the developer's guide to set up your environment
    • Read the codebase overview to understand the structure of the codebase and follow the conventions
  4. Contribute a new component or enhancement to an existing component

3. Make a pull request​

First, thanks for taking the time. :)

  1. Clone the repository on your local build machine
  2. Commit any changes to a new branch
  3. Be sure to update any associated documentation or README files related to your changes
  4. Push the branch to Github and create a PR
  5. A core team member or trusted committer will merge your PR once you have the approval of two other developers

Key considerations for pull requests:

  • Please create a Github issue before creating a PR
  • Make sure the pull request description clearly describes the problem and the solution
  • Include the relevant issue number when you submit your pull request

For those who don't have the required permissions to submit pull requests to UDS, you can fork the UDS repo, make your proposed changes or fixes, then submit your PR.

Learn how to open a pull request on GitHub