Skip to content

Latest commit

 

History

History
32 lines (24 loc) · 1.42 KB

CONTRIBUTING.md

File metadata and controls

32 lines (24 loc) · 1.42 KB
Raw

Contributing

Workflow

MongoDB welcomes community contributions! If you’re interested in making a contribution to the MongoDB Shell, please follow the steps below before you start writing any code:

  1. Sign the contributor's agreement. This will allow us to review and accept contributions.
  2. Fork the repository on GitHub
  3. Create a branch with a name that briefly describes your feature
  4. Implement your feature or bug fix
  5. Add new test cases that verify your bug fix or make sure no one unintentionally breaks your feature in the future and run them with npm test
    • You can use it.only() instead of it() in mocha tests to run only a subset of tests. This can be helpful, because running the full test suite likely takes some time.
  6. Add comments around your new code that explain what's happening
  7. Commit and push your changes to your branch then submit a pull request

Bugs

You can report new bugs by creating a new issue. Please include as much information as possible about your environment.

Node.js versions

We support Node.js 14.x+ for the individual packages, and Node.js 16.x only for the CLI repl specifically. These versions are mentioned:

  • In the individual packages’ package.json files
  • In the evergreen config
  • In the homebrew generation script
  • In the Docker files we use for building the binary/testing vscode