Skip to content

Latest commit

 

History

History
46 lines (33 loc) · 1.77 KB

CONTRIBUTING.md

File metadata and controls

46 lines (33 loc) · 1.77 KB
Raw

Contributing

Workflow

MongoDB welcomes community contributions! If you’re interested in making a contribution to MongoDB Compass, 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 cases to ./src/test that verify your bug fix or make sure no one unintentionally breaks your feature in the future and run them with npm test
  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.

Development

We recommend familiarizing yourself with the VSCode extension documentation: code.visualstudio.com/api.

Running the MongoDB VSCode plugin requires Node.js and npm.

  1. Clone this project, navigate to the folder, then run:
npm install
npm run watch
  1. Inside of VS Code Insiders open this directory and press F5 to begin debugging the extension. This should launch a new VSCode window which is running the extension.

Code Tour

  • out compiled extension code
  • images Icons, logos, etc.
  • snippets [Bundled MongoDB Snippets][snippet guide]
  • syntaxes [Syntax highlighting for .mongodb files][syntax guide]
  • src
    • test/suite where tests live with files names *.test.ts
  • scripts project helper scripts