Merge pull request #2734 from nealef/master
[mono.git] / CONTRIBUTING.md
1 Guidelines
2 ==========
3
4 When contributing to the Mono project, please follow the [Mono Coding
5 Guidelines][1].  We have been using a coding style for many years,
6 please make your patches conform to these guidelines.
7
8 [1]: http://www.mono-project.com/community/contributing/coding-guidelines/
9
10 Etiquette
11 =========
12
13 In general, we do not accept patches that merely shuffle code around,
14 split classes in multiple files, reindent the code or are the result
15 of running a refactoring tool on the source code.  This is done for
16 three reasons: (a) we have our own coding guidelines; (b) Some modules
17 are imported from upstream sources and we want to respect their coding
18 guidelines and (c) it destroys valuable history that is often used to
19 investigate bugs, regressions and problems.
20
21 License
22 =======
23
24 The Mono runtime, compilers, and tools and most of the class libraries
25 are licensed under the MIT license. But include some bits of code
26 licensed under different licenses. The exact list is [available here] (https://github.com/mono/mono/blob/master/LICENSE).
27
28 Different parts of Mono use different licenses.  The actual details of
29 which licenses are used for which parts are detailed on the LICENSE
30 file in this directory.
31
32 CLA
33 =======
34
35 Contributions are now taken under the [.NET Foundation CLA] (https://cla2.dotnetfoundation.org/). 
36
37 Testing
38 =======
39
40 Pull requests go through testing on our [Jenkins server][2]. We will
41 usually only merge a pull request if it causes no regressions in a
42 test run there.
43
44 When you submit a pull request, one of two things happens:
45
46 * If you are a new contributor, Jenkins will ask for permissions (on
47   the pull request) to test it. A maintainer will reply to approve
48   the test run if they find the patch appropriate. After you have
49   submitted a few patches, a maintainer will whitelist you so that
50   all of your future pull requests are tested automatically.
51 * If you are a well-known, whitelisted contributor, Jenkins will go
52   ahead and test your pull request as soon as a test machine is
53   available.
54
55 When your pull request has been built, Jenkins will update the build
56 status of your pull request. If it succeeded and we like the changes,
57 a maintainer will likely merge it. Otherwise, you can amend your pull
58 request to fix build breakage and Jenkins will test it again.
59
60 [2]: http://jenkins.mono-project.com/
61
62 # Inactivity
63
64 Occasionally, a pull request sits for several months without any
65 response from the author. This isn't necessarily an issue, but we may
66 sometimes decide to close pull requests that have not seen any
67 progress for a long time. This is in interest of keeping the pull
68 request list clean so that other pull requests don't get lost in the
69 clutter.
70
71 If we do close your pull request due to inactivity, you're more than
72 welcome to submit it anew after you address any comments or issues that
73 were brought up on the original pull request.