diff --git a/README.md b/README.md index e5b2276b..98e561b5 100644 --- a/README.md +++ b/README.md @@ -127,6 +127,8 @@ For more information about how to use the GitHub Copilot CLI, see [our official For the Linear WWW-3 visual, open `connect-your-tools.html` in a browser to see the recreated "Connect your tools" gradient + icon composition. +For LIN-5 handoff and future link-development maintenance, use: `docs/lin-5-link-development-checklist.md`. + ## 📢 Feedback and Participation We're excited to have you join us early in the Copilot CLI journey. diff --git a/changelog.md b/changelog.md index af10e0e5..749c12d6 100644 --- a/changelog.md +++ b/changelog.md @@ -1,5 +1,6 @@ ## Unreleased +- Complete LIN-5 with a link-development checklist and README handoff reference - Add LIN-1 test follow-up note to complete Linear smoke test workflow ## 0.0.369 - 2025-12-11 diff --git a/docs/lin-5-link-development-checklist.md b/docs/lin-5-link-development-checklist.md new file mode 100644 index 00000000..32776d6e --- /dev/null +++ b/docs/lin-5-link-development-checklist.md @@ -0,0 +1,42 @@ +# LIN-5 Link Development Checklist + +This guide closes **LIN-5** and gives a practical checklist for link-related development so future updates are consistent and easy to maintain. + +## 1) Source references + +- Jira dashboard for tracking: + `https://nguyencuong2509-1772060629335.atlassian.net/jira/dashboards/10000` +- Local mock reference in this repository: + - `examples/connect-your-tools.html` + - README section: **Connect your tools mock** + +## 2) Recommended local workflow + +1. Create a short branch name tied to the issue (for example: `lin-5-link-check`). +2. Update docs and mock files together so links and descriptions stay aligned. +3. Verify every added/updated URL is: + - reachable, + - using HTTPS, + - and written once in canonical format. +4. Validate markdown formatting and ensure changed files are non-empty. +5. Add a short changelog note under `Unreleased` when user-visible docs are updated. + +## 3) Done criteria for link-related tasks + +A LIN-5 style “link check & finish” task is done when all items below are true: + +- [ ] Link targets are correct and use final URLs. +- [ ] README points to the latest relevant local doc or mock. +- [ ] Supporting doc explains purpose, maintenance notes, and where to extend. +- [ ] Changelog contains one concise completion note. +- [ ] Basic repository checks pass (`git diff --check`, file presence/non-empty checks). + +## 4) Maintenance notes + +- Prefer repository-relative references for local files (`docs/...`, `examples/...`) over repeating long explanations. +- Keep one checklist doc per issue when the change is process/documentation oriented. +- If links change in future issues, update this checklist and README in the same PR. + +--- + +If this file is updated later, keep the structure above so contributors can quickly verify “what to check” and “what marks the task complete.”