Skip to content

Latest commit

 

History

History
93 lines (62 loc) · 3.59 KB

CONTRIBUTING.rst

File metadata and controls

93 lines (62 loc) · 3.59 KB
Raw

Contributing to the MongoDB project

Pull requests are always welcome, and the MongoDB dev team appreciates any help the community can give to help make MongoDB better.

For any particular improvement you want to make, you can begin a discussion on the MongoDB Developers Forum. This is the best place discuss your proposed improvement (and its implementation) with the core development team.

Getting Started

JIRA Tickets

All commits to the MongoDB repository must reference an issue in the SERVER project of the MongoDB JIRA. Before creating any new tickets, please search the existing backlog for any open tickets that represent your change request. If there is not one, then you should create a new ticket.

For bugs, please clearly describe the issue you are resolving, including the platforms on which the issue is present and clear steps to reproduce.

For improvements or feature requests, be sure to explain the goal or use case and the approach your solution will take.

The Life Cycle of a Pull Request

Here's what happens when you submit a pull request:

  • The MongoDB engineering team will review your pull request to make sure you have included a SERVER ticket in your request and signed the contributor agreement.
  • You should receive a response from one of our engineers with additional questions about your contributions.
  • If your pull request matches a ticket and is aligned with the Server Roadmap, it will get triaged and reviewed by the Kernel team.
  • Pull requests that have been reviewed and approved will be signed off and merged into a development branch and the associated JIRA SERVER issue will be resolved with an expected fixVersion.

Style Guide

All commits to the MongoDB repository must follow the kernel development rules.

In particular, all code must follow the MongoDB kernel code style guidelines. For anything not covered in this document you should default to the Google CPP Style Guide and the Google JavaScript Style Guide.

Your commit message should also be prefaced with the relevant JIRA ticket, e.g. "SERVER-XXX Fixed a bug in aggregation".

Testing

Every non-trivial change to the code base should be accompanied by a relevant addition to or modification of the test suite. If you don't believe this is necessary, please add an explanation in the JIRA ticket why no such changes are either needed or possible.

All changes must also pass the full test suite (including your test additions/changes) on your local machine before you open a pull request.

Contributor Agreement

A patch will only be considered for merging into the upstream codebase after you have signed the contributor agreement.