Skip to content

Add doc comment standards and publishers helper foundation - #121

Closed
alng20 wants to merge 1 commit into
github-samples:mainfrom
alng20:update-custom-instructions
Closed

alng20 wants to merge 1 commit into
github-samples:mainfrom
alng20:update-custom-instructions

Conversation

@alng20

@alng20 alng20 commented Sep 26, 2026 •

Copy link
Copy Markdown

Description

Related Issue

Type of Change

  • 🐛 Bug fix (non-breaking change that fixes an issue)
  • ✨ New feature (non-breaking change that adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to change)
  • 📚 Documentation update
  • 🧪 Test update
  • 🔧 Refactor (no functional changes)

Changes Made

Testing

Data Layer Changes

  • Ran npm run test:unit - all tests pass
  • Added/updated Vitest tests for data-layer changes
  • Generated a migration (npm run db:generate) for any schema change

Frontend Changes

  • Ran npm run test:e2e - all tests pass
  • Added data-testid attributes to interactive elements
  • Verified build succeeds (npm run build)

Checklist

  • My code follows the project's coding standards
  • I have used explicit TypeScript types for function parameters and return values
  • I have built the UI with Astro components and Tailwind CSS utility classes (dark theme)
  • I have updated documentation (README, instruction files) if needed
  • My changes are focused on a single concern
  • I have written clear commit messages explaining what and why

Additional Notes

Copilot AI lite review requested due to automatic review settings September 26, 2026 02:20
@alng20 alng20 closed this Sep 26, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot review overview

🟡 Changes recommended

Add helper tests and document the standards in the required repository instruction and README locations.

Review effort: Lite
Findings: 1 Low severity

Open (1)
What changed in this PR

Adds repository documentation standards and a typed, deterministic publisher data-access helper.

Changes:

  • Documents TSDoc and file-purpose comment requirements.
  • Adds getAllPublishers with deterministic name ordering.
File Summary
src/​lib/​publishers.ts Adds publisher query helper; unit coverage is still needed.
.github/​copilot-instructions.md Adds documentation standards; corresponding repository documentation is still needed.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread src/lib/publishers.ts
* @param db - The Drizzle database client to query.
* @returns A promise that resolves to publisher summaries ordered by name.
*/
export async function getAllPublishers(db: Database): Promise<Publisher[]> {
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants