Contributor workflow

How to get a change into a TEDI library. Which quality bar applies depends on the component tier. See Architecture and the Definition of Done.

Branches, test environments and release mechanics are covered in Gitflow; branch and commit naming in Commit convention.

Contributor workflow

For contributors without push access, working from a fork.

1. Open an issue in GitHub. Describe what you are planning to do, for example propose the component API and the libraries you intend to use.
2. Fork the repository. To get a test environment on your fork:
   • Under your fork, go to Settings → Pages:
     • Under "Build and deployment", set Source to GitHub Actions.
     • Enable Actions under the Actions tab.
     • Create an environment named github-pages under Environments, and make sure No restriction is selected under "Deployment branches and tags".
3. Make your changes and open a pull request against the rc branch of the origin repository.
4. For changes to TEDI-Ready components, deploy your component to the test environment:
   • Deployment is automated by the "Continuous Deployment" GitHub Actions workflow.
   • If Actions were enabled before you pushed, it runs automatically. Otherwise select "Continuous Deployment" in the sidebar and click "Run workflow".
   • Once the "Deploy" step completes, copy the generated GitHub Pages link and add it to your pull request.

Maintainer workflow

For team members with push access, working in the origin repository.

1. Open an issue in GitHub.
2. Create a branch off rc: see Branch name.
3. Make your changes and open a pull request against rc.
4. The branch is deployed to Storybook automatically, at https://storybook.tedi.ee/<framework>/<branch>/. Add the link to the pull request for review.
5. Another maintainer reviews and merges. The change is then published in the next pre-release version.

Merging is restricted to team members (repository permissions are managed through GitHub teams), so anyone can contribute and review, but a team member performs the merge.

AI tooling for contributors

Each library ships a contributing skill that guides development inside that repository: creating components, running tests and lint, WCAG audits, refactoring and writing Storybook stories. It is available as /contributing when working in the repository.

ai-skills packages the contributor skills as a Claude Code plugin marketplace, so they can be installed rather than copied. It is a work in progress.

These are contributor skills. For using TEDI in your own application see Building with AI, and for prototyping see Designing with AI.