man page: describe recovery service.
[oweals/dinit.git] / doc / CONTRIBUTING
1 Contributing to Dinit's development
2 ===================================
3
4 At the time of writing there have been only minimal outside contributions, but I'm writing this
5 contribution guide in readiness for contributions being made by other persons.
6
7
8 Code contributions
9 ------------------
10
11 In general, code contributions:
12  - should follow existing style and conventions
13  - should keep the design considerations in mind (read the DESIGN document)
14  - should be accompanied by appropriate documentation additions/updates
15  - should include tests where practical
16
17 As the maintainer and original author, I maintain the right to reject or request modification to
18 contributions, for failure to comply with the points listed above, for failure to adhere to a
19 reasonable standard of conduct (see Contributor Conduct below), or because I deem that the
20 contribution includes features outside the intended scope. Feel free to contact me to sound
21 out whether I would be likely to accept a submission for a particular feature.
22
23 Contributors should feel free to create (or add themselves to) a CONTRIBUTORS list as part of
24 the patch/pull request.
25
26 I will endeavour to respond to all offered contributions with civility and respect, even if I
27 choose not to accept them.
28
29
30 Contributor Conduct
31 -------------------
32
33 There is no complete "code of conduct" for Dinit contributors, but contributions will only be
34 accepted from those who are civil and respectful towards others. Specific behaviours that won't
35 be tolerated from contributors include but are not limited to:
36
37  - discrimination generally, and especially if based on race, gender or gender identity, sexual
38    preference, etc
39  - personal attacks, insults, or harassment, or incitement thereof, against others
40  - unnecessarily drawing attention to another's personal issues or conditions, or other personal
41    details
42
43 If a person is deemed to have engaged in negative behaviour such as from the list above,
44 contributions from them will not be accepted and the perpetrator may be blocked from
45 communications related to Dinit development. Note that such negative behaviours need not have
46 occurred in a public forum, and need not be related to Dinit development.
47
48 In short: don't be nasty to others; arseholes won't be tolerated.
49
50 If you feel that a contributor has behaved inappropriately, please feel free to contact me to
51 discuss it; such communication will be kept confidential (unless and until otherwise agreed).