xref: /freebsd/crypto/krb5/doc/contributing.txt (revision 7f2fe78b9dd5f51c821d771b63d2e096f6fd49e9)
1                     Contributing to MIT Kerberos
2
3DESIGN
4======
5
6If you are planning to contribute a substantial amount of work, please
7ensure that you have a discussion about the design on the
8krbdev@mit.edu list.  Some changes may require coordination with
9standards groups.  For example, interface changes and extensions for
10the GSS-API should be discussed in the IETF KITTEN Working Group.
11
12STYLE
13=====
14
15Please follow the guidelines in doc/coding-style for new code.  For
16existing code, please preserve its existing indentation and brace
17conventions.  These existing conventions usually resemble the
18guidelines in doc/coding-style.  Exceptions to the style in
19doc/coding-style are usually large past contributions or imports from
20other parties.  These include (not an exhaustive list):
21
22    src/appl/bsd
23    src/appl/gssftp
24    src/appl/telnet
25    src/kadmin
26    src/lib/kadm5
27    src/lib/gssapi/mechglue
28    src/lib/rpc
29
30PATCHES
31=======
32
33We prefer patches in either unified or context diff format (diff -u or
34diff -c).  As is usual practice, please specify the original file
35before the modified file on the diff command line.  It's also useful
36to perform the diff from the top level of the tree, e.g.,
37
38    diff -ur src.orig src
39
40It's even more useful if you use our anonymous Subversion repository
41at
42
43    svn://anonsvn.mit.edu/krb5
44
45and use "svn diff" (or "svk diff" if you prefer to use SVK) to
46generate your patches.
47
48It is much easier for us to integrate patches which are generated
49against current code on the trunk.  Please ensure that your source
50tree is up-to-date before generating your patch.
51
52COPYRIGHT
53=========
54
55If you are submitting substantial quantities of new code, or are
56substantially modifying existing code, please be clear about the
57copyright status of your contributions.  Note that if your
58contribution was created in the course of your employment, your
59employer may own copyright in your contribution.
60
61We prefer that MIT receives the ownership of the contributions, but
62will generally accept contributed code with copyright owned by other
63parties provided that the license conditions are substantially
64identical to the existing license on the MIT krb5 code.
65
66Appropriate copyright notices and license terms should be added to new
67or changed files, unless the contributed code is being assigned to the
68already-listed copyright holder in the file, or the contribution is
69being released to the public domain.  Please make sure that the
70year in the copyright statement is kept up-to-date.
71