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