docs(NODE-7768): align with team practices - #129
Open
johnmtll wants to merge 2 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
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-commithook that runsscripts/symlink-claude-md.sh. - Add an npm
preparescript to configurecore.hooksPathto 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.
seanrmilligan
approved these changes
Aug 14, 2026
PavelSafronov
approved these changes
Aug 14, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
npm run check:lint)type(NODE-xxxx)[!]: descriptionfeat(NODE-1234)!: rewriting everything in coffeescript