1
Contributing to the MongoDB project
2
===================================
4
Pull requests are always welcome, and the MongoDB dev team appreciates any help the community can
5
give to help make MongoDB better.
7
For any particular improvement you want to make, you can begin a discussion on the
8
`MongoDB Developers Forum`_. This is the best place discuss your proposed improvement (and its
9
implementation) with the core development team.
11
.. _MongoDB Developers Forum: https://groups.google.com/forum/?fromgroups#!forum/mongodb-dev
17
- Create a `MongoDB JIRA account`_.
18
- Create a `Github account`_.
19
- Fork the repository on Github at https://github.com/mongodb/mongo.
21
.. _MongoDB JIRA account: https://jira.mongodb.org/secure/Signup!default.jspa
22
.. _Github account: https://github.com/signup/free
28
All commits to the MongoDB repository must reference an issue in the `SERVER project`_ of the
29
MongoDB JIRA. Before creating any new tickets, please search the existing backlog for any open
30
tickets that represent your change request. If there is not one, then you should create a new
33
For bugs, please clearly describe the issue you are resolving, including the platforms on which
34
the issue is present and clear steps to reproduce.
36
For improvements or feature requests, be sure to explain the goal or use case and the approach
37
your solution will take.
39
.. _SERVER project: https://jira.mongodb.org/browse/SERVER
45
All commits to the MongoDB repository must follow the `kernel development rules`_.
47
In particular, all code must follow the MongoDB `kernel code style guidelines`_. For anything
48
not covered in this document you should default to the `Google CPP Style Guide`_ and the
49
`Google JavaScript Style Guide`_.
51
Your commit message should also be prefaced with the relevant JIRA ticket, e.g. "SERVER-XXX Fixed
52
a bug in aggregation".
54
.. _kernel development rules: http://dochub.mongodb.org/core/kernelcodedevelopmentrules
55
.. _Kernel Code Style guidelines: http://dochub.mongodb.org/core/kernelcodestyle
56
.. _Google CPP Style Guide: http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml
57
.. _Google JavaScript Style Guide: http://google-styleguide.googlecode.com/svn/trunk/javascriptguide.xml
63
Every non-trivial change to the code base should be accompanied by a relevant addition to or
64
modification of the test suite. If you don't believe this is necessary, please add an explanation
65
in the JIRA ticket why no such changes are either needed or possible.
67
All changes must also pass the full test suite (including your test additions/changes) on your
68
local machine before you open a pull request.
74
A patch will only be considered for merging into the upstream codebase after you have signed the
75
`contributor agreement`_.
77
.. _contributor agreement: http://www.10gen.com/contributor
b'\\ No newline at end of file'