Repository navigation
docs: add contributing guide and community files #778 #779
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
mart-sessman
wants to merge
2
commits into
rc
Choose a base branch
from
docs/778-community-files
base: rc
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+103
−2
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| --- | ||
| name: Accessibility issue | ||
| about: A component is hard or impossible to use with a keyboard, screen reader, zoom or other assistive technology | ||
| title: "[Component_name]:" | ||
| labels: wcag | ||
| assignees: '' | ||
|
|
||
| --- | ||
|
|
||
| ## Problem | ||
|
|
||
| <!-- What doesn't work, and for whom. --> | ||
|
|
||
| ## Steps to reproduce | ||
|
|
||
| 1. | ||
|
|
||
| ## Expected behaviour | ||
|
|
||
| ## Environment | ||
|
|
||
| <!-- Browser, operating system, assistive technology and version (e.g. NVDA 2026.1 + Firefox). --> | ||
|
|
||
| ## WCAG success criterion | ||
|
|
||
| <!-- If known, e.g. 2.4.7 Focus Visible. --> | ||
|
|
||
| ## Project |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| blank_issues_enabled: true | ||
| contact_links: | ||
| - name: Report a security vulnerability | ||
| url: https://github.com/TEDI-Design-System/angular/security/advisories/new | ||
| about: Report privately. Please do not open a public issue. | ||
| - name: Ask a question | ||
| url: https://join.slack.com/t/tedisystem/shared_invite/zt-3hd8tnjf7-Z1smXI~ns0p8E2cxoFUKbQ | ||
| about: Questions about using TEDI go to the TEDI Slack. | ||
| - name: Propose a new component or feature | ||
| url: https://github.com/TEDI-Design-System/general/discussions | ||
| about: New components and improvement ideas start as a discussion. | ||
| - name: Report a design or UX problem | ||
| url: https://github.com/TEDI-Design-System/design/issues | ||
| about: Design problems in existing components are handled in the design repository. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| # Contributing to TEDI Angular | ||
|
|
||
| Thanks for helping improve `@tedi-design-system/angular`. This page covers what is specific to this repository. The full process (component tiers, Definition of Done, Gitflow, release process) is in the [TEDI wiki](https://github.com/TEDI-Design-System/general/wiki). | ||
|
|
||
| Everyone taking part is expected to follow the [Code of Conduct](https://github.com/TEDI-Design-System/.github/blob/main/CODE_OF_CONDUCT.md). | ||
|
|
||
| ## Reporting issues | ||
|
|
||
| - **Bugs:** open an issue and pick the template that matches the component tier (TEDI-READY or community). | ||
| - **New components and feature ideas:** propose them in [Discussions](https://github.com/TEDI-Design-System/general/discussions). | ||
| - **Design or UX problems:** report them in the [design](https://github.com/TEDI-Design-System/design/issues) repository. | ||
| - **Accessibility problems:** use the "Accessibility issue" template. | ||
| - **Security vulnerabilities:** do not open a public issue. Report privately via [Security → Report a vulnerability](https://github.com/TEDI-Design-System/angular/security/advisories/new) or email info@tedi.ee. See the [security policy](https://github.com/TEDI-Design-System/.github/blob/main/SECURITY.md). | ||
| - **Questions:** ask in the [TEDI Slack](https://join.slack.com/t/tedisystem/shared_invite/zt-3hd8tnjf7-Z1smXI~ns0p8E2cxoFUKbQ). See [Getting help](https://github.com/TEDI-Design-System/.github/blob/main/SUPPORT.md) for other channels. | ||
|
|
||
| ## Making a change | ||
|
|
||
| 1. Open an issue first and describe what you plan to do. New components start as a [Discussion](https://github.com/TEDI-Design-System/general/discussions), where the API can be agreed before an issue is created. | ||
| 2. Branch off `rc` (fork the repository if you don't have push access). Name the branch `<type>/<issue number>-<short-description>`, for example `feat/123-add-tooltip`. | ||
| 3. Write commits in the [commit convention](https://github.com/TEDI-Design-System/general/wiki/Commit-convention) format with the issue number in the header. Releases are generated from commit messages, and a `commit-msg` hook checks the format. | ||
| 4. Open a pull request against `rc`. Add `Closes #<issue number>` to the description so the issue closes on merge. | ||
|
|
||
| Maintainers and fork contributors have slightly different steps for test environments. See [Contributor workflow](https://github.com/TEDI-Design-System/general/wiki/Contributor-workflow). | ||
|
|
||
| ## Local setup | ||
|
|
||
| Requires Node.js 24 (see `.nvmrc`). | ||
|
|
||
| ```bash | ||
| npm install | ||
| npm run start # Storybook on http://localhost:6006 | ||
| npm run lint # stylelint + Angular ESLint, with --fix | ||
| npm run test # Jest | ||
| npm run test:coverage # Jest with coverage (80% threshold) | ||
| npm run build # library build into dist/ | ||
| ``` | ||
|
|
||
| Components live in two tiers: `src/tedi/` (TEDI-READY, must meet the [Definition of Done](https://github.com/TEDI-Design-System/general/wiki/Definition-of-Done)) and `src/community/` (looser requirements). | ||
|
|
||
| ## Accessibility check | ||
|
|
||
| Every pull request to `rc` or `main` runs an automated accessibility check (axe, through the Storybook test runner) on all `src/tedi/` stories. Violations in components the pull request changes fail the check. Violations elsewhere are reported as warnings. | ||
|
|
||
| To run it locally: | ||
|
|
||
| ```bash | ||
| npx playwright install --with-deps chromium | ||
| STORYBOOK_EXCLUDE_COMMUNITY=true npm run build:sb:chromatic | ||
| npm run test-storybook:ci | ||
|
coderabbitai[bot] marked this conversation as resolved.
|
||
| ``` | ||
|
|
||
| This runs the raw tests, so every violation fails, including ones outside the components you changed. Only CI separates failures from warnings. | ||
|
|
||
| A story with a known, tracked accessibility issue can be marked with `parameters: { a11y: { test: "todo" } }` so it warns instead of failing. Link the tracking issue in a comment next to it. | ||
|
|
||
| The automated check catches only part of the problems. TEDI-READY components also need manual testing (keyboard, screen reader, zoom), as listed in the Definition of Done. | ||
|
|
||
| ## AI tooling | ||
|
|
||
| The repository ships a `contributing` skill for AI coding agents, available as `/contributing`. It covers creating components, tests, lint, accessibility audits and stories. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.