Conversation
|
There was a problem hiding this comment.
Pull request overview
Adds a “DOCUMENTATION-REQUIRED” badge style and updates contributor guidance to direct contributors to create matching documentation updates when working on labeled issues.
Changes:
- Add
documentationRequiredvariant styling to the sharedBadgecomponent. - Extend the contributing “Getting Started” page with guidance + links for the
DOCUMENTATION-REQUIREDlabel. - Minor documentation-only edits (README text line and additional blank lines in an MDX page).
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| src/pages/explanations/supply-chain-security/provenance-tracking.mdx | Adds additional blank lines around the placeholder content. |
| src/pages/contributing/getting-started.mdx | Adds contributor guidance and a new badge/link for DOCUMENTATION-REQUIRED. |
| src/components/ui/badge.tsx | Introduces a new documentationRequired badge variant style. |
| README.md | Adds an extra line of text at the end of the README. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
|
|
There was a problem hiding this comment.
This file change only adds extra blank lines. If there’s no content to insert yet, please drop the additional empty lines to avoid no-op diffs and keep markdown formatting clean.
|
|
||
| If you need assistance or want to connect with the team, feel free to join our [Matrix Community Server](https://matrix.to/#/#devguard:matrix.org) and reach out directly. The Devguard team is happy to support new contributors. | ||
|
|
||
| Some tickets are labeled with a <a href='https://github.com/l3montree-dev/devguard/issues?q=is%3Aissue%20state%3Aopen%20label%3ADOCUMENTATION-REQUIRED'><Badge variant="documentationRequired"> DOCUMENTATION-REQUIRED</Badge></a> badge. When you see this label, the code changes in your contribution also require corresponding documentation updates in the <a href='https://github.com/l3montree-dev/devguard-documentation'>Devguard Documentation Repository</a>. |
There was a problem hiding this comment.
This new contributor note links to https://github.com/l3montree-dev/devguard-documentation, but the rest of this repo references l3montree-dev/devguard-docs (e.g., README.md and SECURITY.md). If the documentation repository is actually devguard-docs, update this link (and the visible name capitalization) so contributors are sent to the right place.
|
|
||
| If you need assistance or want to connect with the team, feel free to join our [Matrix Community Server](https://matrix.to/#/#devguard:matrix.org) and reach out directly. The Devguard team is happy to support new contributors. | ||
|
|
||
| Some tickets are labeled with a <a href='https://github.com/l3montree-dev/devguard/issues?q=is%3Aissue%20state%3Aopen%20label%3ADOCUMENTATION-REQUIRED'><Badge variant="documentationRequired"> DOCUMENTATION-REQUIRED</Badge></a> badge. When you see this label, the code changes in your contribution also require corresponding documentation updates in the <a href='https://github.com/l3montree-dev/devguard-documentation'>Devguard Documentation Repository</a>. |
There was a problem hiding this comment.
JSX attributes in this file use double quotes (and Prettier’s default for JSX is double quotes). These new <a href='...'> attributes use single quotes—please switch them to double quotes for consistency/formatting stability.
2 participants
No description provided.