Skip to content

Add LIN-5 link development checklist and update README and changelog #20

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.

Sign up for GitHub

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

Merged
NguyenCuong1989 merged 1 commit into from
Mar 30, 2026
Merged

Add LIN-5 link development checklist and update README and changelog #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 1 addition & 0 deletions changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
42 changes: 42 additions & 0 deletions docs/lin-5-link-development-checklist.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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`
Comment on lines +7 to +8
Copy link
Copy Markdown

@qodo-code-review qodo-code-review Bot Mar 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Action required

1. Internal jira url exposed 🐞 Bug ⛨ Security

The new LIN-5 checklist hardcodes a tenant-specific Atlassian/Jira dashboard URL, which can disclose
internal infrastructure identifiers/PII and is likely inaccessible to most contributors in a
public-facing repo. This creates unnecessary information disclosure risk and makes the checklist
less useful for external maintainers.
Agent Prompt 
## Issue description
The checklist publishes a tenant-specific Jira dashboard URL in repo docs, which may expose internal identifiers/PII and is not broadly accessible.

## Issue Context
This repository is presented as a public preview project; docs should avoid embedding internal-only links or tenant-specific infrastructure references.

## Fix Focus Areas
- docs/lin-5-link-development-checklist.md[5-12]

## Expected change
- Remove the tenant-specific URL, or replace it with a non-sensitive placeholder (e.g., "Internal tracking dashboard (link omitted)") or a public, repo-local reference (e.g., GitHub Issues/Projects link if applicable).

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

- 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.”