Skip to content

docs: add LEARNINGS.md and PR template for AI agent guidance#98

Merged
nitrocode merged 1 commit into
mainfrom
copilot/create-learning-document-structure
Apr 27, 2026
Merged

docs: add LEARNINGS.md and PR template for AI agent guidance#98
nitrocode merged 1 commit into
mainfrom
copilot/create-learning-document-structure

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 26, 2026

No structured way existed for AI agents to learn from past PRs or produce consistent PR descriptions. Adds a living learnings log and a GitHub PR template to close both gaps.

Summary

docs/LEARNINGS.md gives agents a categorised reference of 28 lessons extracted from PRs #54#94 (mobile/CSS quirks, build system rules, test reliability, architecture boundaries, security, feature design, release flow) plus a per-PR log with Problem/Approach/Learning/Key-files entries. .github/pull_request_template.md enforces a uniform Summary → Changes → Agent Checklist structure on every PR going forward. AGENTS.md is updated to surface both documents immediately and adds a "must add learning entry" rule to the session-end requirements.

Changes

Agent Checklist

  • npm run test:ci passes (all unit tests green, coverage not decreased)
  • npm run build && npm run test:e2e passes (all E2E tests green)
  • No generated files committed (script.js, styles.css, *-data.js)
  • All dynamic innerHTML values pass through escHtml()
  • No DOM references introduced in death-clock-core.js
  • No new runtime npm packages added
  • GitHub Actions uses: pins use a full commit SHA + inline semver comment
  • PR title follows Conventional Commits (feat:, fix:, docs:, chore:, etc.)
  • project-stats.yaml updated if this session merges one or more PRs
  • Relevant entry added to docs/LEARNINGS.md (new pattern or lesson learned)

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 26, 2026

Warning

Rate limit exceeded

@nitrocode has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 8 minutes and 42 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 8 minutes and 42 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 4ca8ba65-e9c6-4cf0-88d5-a4049f754da6

📥 Commits

Reviewing files that changed from the base of the PR and between 2442787 and b2adf12.

📒 Files selected for processing (3)
  • .github/pull_request_template.md
  • AGENTS.md
  • docs/LEARNINGS.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch copilot/create-learning-document-structure

Comment @coderabbitai help to get the list of available commands and usage tips.

@nitrocode nitrocode marked this pull request as ready for review April 26, 2026 23:59
@nitrocode nitrocode self-requested a review as a code owner April 26, 2026 23:59
github-actions Bot added a commit that referenced this pull request Apr 27, 2026
@github-actions
Copy link
Copy Markdown
Contributor

👁️ PR Preview

🚀 Open Preview

Deployed from commit b2adf12 · Updates on every push to this PR
(Preview is removed automatically when the PR is closed.)

Screenshots

Desktop Mobile
Desktop Mobile

github-actions Bot added a commit that referenced this pull request Apr 27, 2026
@nitrocode nitrocode merged commit dcd0456 into main Apr 27, 2026
7 checks passed
@nitrocode nitrocode deleted the copilot/create-learning-document-structure branch April 27, 2026 00:19
github-actions Bot added a commit that referenced this pull request Apr 27, 2026
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