Current version 22.0.0

Adding or changing content

Before getting started, post your idea in the #tangram channel . They will help you to determine whether the proposed changes or new content are suitable for Tangram, and where it will live on the Tangram app.

Examples of content contributions:

  • Updating or clarifying existing documentation
  • Adding accessibility notes to component documentation
  • Creating new content such as design patterns or guidelines

Some content that is FrEnd specific, or content that is subject to change in the short term may not be suitable for Tangram.

Creating content for Tangram

  • Create a case for the piece of work on your team's board, with as much detail and any relevant links.
  • Make changes or add content in the google doc, using the documentation style guide.
  • Update the changelog.
  • Request a content & design review in the #tangram channel.
  • Once approved, the changes are ready to publish on the Tangram app. Nice job!

Publishing content

Once additions or changes to content have been approved, these can be published on the Tangram app following these steps:

  • Pull down the Tangram repo.
  • Create a new branch using the Jira ID of the case.
  • Make the changes on your branch.
  • Update the changelog.
  • Request a code review of your additions via the Slack Workflow in the #tangram channel .
  • When you are ready to deploy the case, close your branch and update to the Tangram main branch.
  • Merge your branch into the Tangram main branch.
  • When the main branch has built, check it locally and request a Tangram deploy via the Slack Workflow in the #tangram channel.
  • Notify the #tangram channel of the newly published changes.

Adding or improving a component

Communication and transparency via the #tangram channel at regular stages throughout this process ensures all teams are aware of your contribution and provides the opportunity to help and engage.

Post your progress where the word ‘communicate’ is present in the below steps.

  1. Communicate intentions upfront
    1. Describe the value your proposed contribution has as a shared solution.
    2. Talk to interested parties/guilds and arrange meetings if appropriate.
  2. Create a case for the piece of work on your team's board, with as much detail and any relevant links.
    1. Add all available information and share a link to the case to invite/enable participation.
  3. Begin the phase to further understand the requirements and challenges and add notes to the Jira case. Also, consider:
    1. How might Performance, Perceived-Performance, Usability, Accessibility, and/or Security implications affect the scope of this case?
    2. Are your changes able to remain isolated from any existing code? How might this affect the test plan?
    3. How can you ensure you’re keeping the shared solution generic while also catering to the needs of your specific use case which lead to the need for this component?
  4. Communicate – share your proposal for transparency and to gather support for the next steps.
    For larger contributions, consider also sharing via the guild channels and meetings.
  5. Design and implement the proposed changes (including tests as appropriate) to the initial review stage. You may choose to reach out for early in-progress review feedback along the way.
    Remember to lint your work to save time in review.
  6. Ensure that your changes include documentation updates in line with existing Tangram components and features. Updated the changelog. Reference the documentation style guide and follow the adding content process.
  7. Request review via the Slack Workflow in the #tangram channel.
  8. Get test support from your normal channels and share your test plan for transparency and additional support.
    1. Tangram has no environments available: testing needs to be done locally.
    2. Testing will need to include the component itself as well as the documentation related changes.
    3. Follow normal testing processes used in FrEnd as appropriate, ensuring that cross-browser and device support is included as per normal.
    4. For a ‘new’ Tangram contribution testing is not required in FrEnd.
      The risk to FrEnd or other existing applications should be mitigated during previous parts of this process ie. code review to ensure no FrEnd regressions are possible.
    5. If ANY changes have been made to existing code (ie. code outside of your ‘new’ contribution) you must also follow consumer (e.g. FrEnd) regression testing processes. 
  9. When you are ready to deploy the case, close your branch and update to the Tangram default branch.
  10. Merge your branch into the Tangram default branch.
  11. When the default branch has built, promote it to a test environment and request a Tangram deploy via the Slack Workflow in the #tangram channel .
  12. Notify the #tangram channel of the newly published changes.

Bug fixes

Coming soon

Design pattern coming soon! In the meantime, the #tangram channel is always available for support.

Proudly made by © 2026 Trade Me Limited