Skip to content

docs(NODE-7768): align with team practices - #129

Open
johnmtll wants to merge 2 commits into
mainfrom
NODE-7768/align-agents-md
Open

docs(NODE-7768): align with team practices#129
johnmtll wants to merge 2 commits into
mainfrom
NODE-7768/align-agents-md

Conversation

@johnmtll

Copy link
Copy Markdown
Contributor

Description

Summary of Changes

After team discussions in mongodb/js-bson#915, some additional features were onboarded when considering agentic development. These changes mirror the additions added in the aforementioned PR.

Notes for Reviewers

What is the motivation for this change?

Release Highlight

Release notes highlight

Double check the following

  • Lint is passing (npm run check:lint)
  • Self-review completed using the steps outlined here
  • PR title follows the correct format: type(NODE-xxxx)[!]: description
    • Example: feat(NODE-1234)!: rewriting everything in coffeescript
  • Changes are covered by tests
  • New TODOs have a related JIRA ticket

@johnmtll
johnmtll requested a review from a team as a code owner August 13, 2026 20:18
Copilot AI lite review requested due to automatic review settings August 13, 2026 20:18
@johnmtll johnmtll changed the title chore: align with team practices docs(NODE-7768): align with team practices Aug 13, 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.

Pull request overview

This PR aligns the repo with team agentic-development practices by formalizing how AGENTS.md/CLAUDE.md references are kept in sync and by adding automated enforcement via a Git pre-commit hook.

Changes:

  • Add a .githooks/pre-commit hook that runs scripts/symlink-claude-md.sh.
  • Add an npm prepare script to configure core.hooksPath to use .githooks.
  • Update documentation and agent guidelines (README + AGENTS.md) and annotate the vendored script.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
scripts/symlink-claude-md.sh Adds vendoring notice header for the sync script.
README.md Updates contributor steps for staging AGENTS.md before generating CLAUDE.md, and notes the script is vendored.
package.json Adds prepare hook to set core.hooksPath to .githooks.
AGENTS.md Clarifies Conventional Commits expectations for PR descriptions vs. squashed commits.
.githooks/pre-commit Introduces a pre-commit hook to run the AGENTS.md/CLAUDE.md sync script automatically.

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

Comment thread package.json Outdated
@seanrmilligan seanrmilligan self-assigned this Aug 14, 2026
@seanrmilligan seanrmilligan added the Primary Review In Review with primary reviewer, not yet ready for team's eyes label Aug 14, 2026
@seanrmilligan seanrmilligan added Team Review Needs review from team and removed Primary Review In Review with primary reviewer, not yet ready for team's eyes labels Aug 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Team Review Needs review from team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants