~evarlast/ubuntu/utopic/mongodb/upstart-workaround-debian-bug-718702

« back to all changes in this revision

Viewing changes to CONTRIBUTING.rst

  • Committer: Package Import Robot
  • Author(s): James Page, James Page, Robie Basak
  • Date: 2013-05-29 17:44:42 UTC
  • mfrom: (44.1.7 sid)
  • Revision ID: package-import@ubuntu.com-20130529174442-z0a4qmoww4y0t458
Tags: 1:2.4.3-1ubuntu1
[ James Page ]
* Merge from Debian unstable, remaining changes:
  - Enable SSL support:
    + d/control: Add libssl-dev to BD's.
    + d/rules: Enabled --ssl option.
    + d/mongodb.conf: Add example SSL configuration options.
  - d/mongodb-server.mongodb.upstart: Add upstart configuration.
  - d/rules: Don't strip binaries during scons build for Ubuntu.
  - d/control: Add armhf to target archs.
  - d/p/SConscript.client.patch: fixup install of client libraries.
  - d/p/0010-install-libs-to-usr-lib-not-usr-lib64-Closes-588557.patch:
    Install libraries to lib not lib64.
* Dropped changes:
  - d/p/arm-support.patch: Included in Debian.
  - d/p/double-alignment.patch: Included in Debian.
  - d/rules,control: Debian also builds with avaliable system libraries
    now.
* Fix FTBFS due to gcc and boost upgrades in saucy:
  - d/p/0008-ignore-unused-local-typedefs.patch: Add -Wno-unused-typedefs
    to unbreak building with g++-4.8.
  - d/p/0009-boost-1.53.patch: Fixup signed/unsigned casting issue.

[ Robie Basak ]
* d/p/0011-Use-a-signed-char-to-store-BSONType-enumerations.patch: Fixup
  build failure on ARM due to missing signed'ness of char cast.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
Contributing to the MongoDB project
 
2
===================================
 
3
 
 
4
Pull requests are always welcome, and the MongoDB dev team appreciates any help the community can
 
5
give to help make MongoDB better.
 
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.
 
10
 
 
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
 
 
21
.. _MongoDB JIRA account: https://jira.mongodb.org/secure/Signup!default.jspa
 
22
.. _Github account: https://github.com/signup/free
 
23
 
 
24
 
 
25
JIRA Tickets
 
26
------------
 
27
 
 
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
 
31
ticket.
 
32
 
 
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.
 
35
 
 
36
For improvements or feature requests, be sure to explain the goal or use case and the approach
 
37
your solution will take.
 
38
 
 
39
.. _SERVER project: https://jira.mongodb.org/browse/SERVER
 
40
 
 
41
 
 
42
Style Guide
 
43
-----------
 
44
 
 
45
All commits to the MongoDB repository must follow the `kernel development rules`_.
 
46
 
 
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`_.
 
50
 
 
51
Your commit message should also be prefaced with the relevant JIRA ticket, e.g. "SERVER-XXX Fixed
 
52
a bug in aggregation".
 
53
 
 
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
 
58
 
 
59
 
 
60
Testing
 
61
-------
 
62
 
 
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.
 
66
 
 
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.
 
69
 
 
70
 
 
71
Contributor Agreement
 
72
---------------------
 
73
 
 
74
A patch will only be considered for merging into the upstream codebase after you have signed the
 
75
`contributor agreement`_.
 
76
 
 
77
.. _contributor agreement: http://www.10gen.com/contributor
 
 
b'\\ No newline at end of file'