Draft
Conversation
| ## Pointers | ||
|
|
||
| - **[CONTRIBUTING.md](./CONTRIBUTING.md)** — developer setup, VS Code config, PR process. | ||
| - **[test/readme.md](./test/readme.md)** — full testing guide (this file only covers the basics). |
Contributor
There was a problem hiding this comment.
Do we need to call these out? I'm wondering if AI will figure this out on its own and our addition may be detrimental.
| - **[test/readme.md](./test/readme.md)** — full testing guide (this file only covers the basics). | ||
| - **Jira: `NODE-XXXX`** — tickets live at [jira.mongodb.org/browse/NODE](https://jira.mongodb.org/browse/NODE). Used as the commit scope. | ||
| - **Node.js**: minimum supported version is in `package.json` `engines.node` (currently `>=20.19.0`). | ||
| - **Do not hand-edit**: `lib/` (build output), `mongodb.d.ts` (generated), `HISTORY.md` (release-please managed), `test/spec/` (vendored from specifications repo). |
Contributor
There was a problem hiding this comment.
Good addition, we definitely need AI to understand which files in the repo are generated.
|
|
||
| ## Code Conventions | ||
|
|
||
| - **Public API stability** — Anything exported from `src/index.ts` flows into the published `mongodb.d.ts` via api-extractor. Renaming, removing, or narrowing exported types/signatures is a breaking change; confirm with a maintainer before doing so. |
Contributor
There was a problem hiding this comment.
Important addition, thanks for this.
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
2 participants
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
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