@@ -4,91 +4,6 @@ Contributing to the MongoDB project
4
4
Pull requests are always welcome, and the MongoDB dev team appreciates any help the community can
5
5
give to help make MongoDB better.
6
6
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.
7
+ For more information about how to contribute, please read `the MongoDB Wiki on GitHub `_.
10
8
11
- .. _MongoDB Developers Forum : https://groups.google.com/forum/?fromgroups#!forum/mongodb-dev
12
-
13
-
14
- Getting Started
15
- ---------------
16
-
17
- - Create a `MongoDB JIRA account `_.
18
- - Create a `Github account `_.
19
- - Fork the repository on Github at https://github.com/mongodb/mongo.
20
- - For more details see http://www.mongodb.org/about/contributors/
21
-
22
- .. _MongoDB JIRA account : https://jira.mongodb.org/secure/Signup!default.jspa
23
- .. _Github account : https://github.com/signup/free
24
-
25
-
26
- JIRA Tickets
27
- ------------
28
-
29
- All commits to the MongoDB repository must reference an issue in the `SERVER project `_ of the
30
- MongoDB JIRA. Before creating any new tickets, please search the existing backlog for any open
31
- tickets that represent your change request. If there is not one, then you should create a new
32
- ticket.
33
-
34
- For bugs, please clearly describe the issue you are resolving, including the platforms on which
35
- the issue is present and clear steps to reproduce.
36
-
37
- For improvements or feature requests, be sure to explain the goal or use case and the approach
38
- your solution will take.
39
-
40
- .. _SERVER project : https://jira.mongodb.org/browse/SERVER
41
-
42
-
43
- The Life Cycle of a Pull Request
44
- --------------------------------
45
-
46
- Here's what happens when you submit a pull request:
47
-
48
- - The MongoDB engineering team will review your pull request to make sure you have included a
49
- SERVER ticket in your request and signed the contributor agreement.
50
- - You should receive a response from one of our engineers with additional questions about your
51
- contributions.
52
- - If your pull request matches a ticket and is aligned with the Server Roadmap, it will get
53
- triaged and reviewed by the Kernel team.
54
- - Pull requests that have been reviewed and approved will be signed off and merged into a
55
- development branch and the associated JIRA SERVER issue will be resolved with an expected
56
- fixVersion.
57
-
58
-
59
- Style Guide
60
- -----------
61
-
62
- All commits to the MongoDB repository must follow the `kernel development rules `_.
63
-
64
- In particular, all code must follow the MongoDB `kernel code style guidelines `_. For anything
65
- not covered in this document you should default to the `Google CPP Style Guide `_ and the
66
- `Google JavaScript Style Guide `_.
67
-
68
- Your commit message should also be prefaced with the relevant JIRA ticket, e.g. "SERVER-XXX Fixed
69
- a bug in aggregation".
70
-
71
- .. _kernel development rules : http://dochub.mongodb.org/core/kernelcodedevelopmentrules
72
- .. _Kernel Code Style guidelines : http://dochub.mongodb.org/core/kernelcodestyle
73
- .. _Google CPP Style Guide : http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml
74
- .. _Google JavaScript Style Guide : http://google-styleguide.googlecode.com/svn/trunk/javascriptguide.xml
75
-
76
-
77
- Testing
78
- -------
79
-
80
- Every non-trivial change to the code base should be accompanied by a relevant addition to or
81
- modification of the test suite. If you do not believe this is necessary, please add an explanation
82
- in the JIRA ticket why no such changes are either needed or possible.
83
-
84
- All changes must also pass the full test suite (including your test additions/changes) on your
85
- local machine before you open a pull request.
86
-
87
-
88
- Contributor Agreement
89
- ---------------------
90
-
91
- A patch will only be considered for merging into the upstream codebase after you have signed the
92
- `contributor agreement `_.
93
-
94
- .. _contributor agreement : http://www.mongodb.com/contributor
9
+ .. _the MongoDB Wiki on GitHub : https://github.com/mongodb/mongo/wiki
0 commit comments