Blame doc/contributing.txt

Packit fd8b60
                     Contributing to MIT Kerberos
Packit fd8b60
Packit fd8b60
DESIGN
Packit fd8b60
======
Packit fd8b60
Packit fd8b60
If you are planning to contribute a substantial amount of work, please
Packit fd8b60
ensure that you have a discussion about the design on the
Packit fd8b60
krbdev@mit.edu list.  Some changes may require coordination with
Packit fd8b60
standards groups.  For example, interface changes and extensions for
Packit fd8b60
the GSS-API should be discussed in the IETF KITTEN Working Group.
Packit fd8b60
Packit fd8b60
STYLE
Packit fd8b60
=====
Packit fd8b60
Packit fd8b60
Please follow the guidelines in doc/coding-style for new code.  For
Packit fd8b60
existing code, please preserve its existing indentation and brace
Packit fd8b60
conventions.  These existing conventions usually resemble the
Packit fd8b60
guidelines in doc/coding-style.  Exceptions to the style in
Packit fd8b60
doc/coding-style are usually large past contributions or imports from
Packit fd8b60
other parties.  These include (not an exhaustive list):
Packit fd8b60
Packit fd8b60
    src/appl/bsd
Packit fd8b60
    src/appl/gssftp
Packit fd8b60
    src/appl/telnet
Packit fd8b60
    src/kadmin
Packit fd8b60
    src/lib/kadm5
Packit fd8b60
    src/lib/gssapi/mechglue
Packit fd8b60
    src/lib/rpc
Packit fd8b60
Packit fd8b60
PATCHES
Packit fd8b60
=======
Packit fd8b60
Packit fd8b60
We prefer patches in either unified or context diff format (diff -u or
Packit fd8b60
diff -c).  As is usual practice, please specify the original file
Packit fd8b60
before the modified file on the diff command line.  It's also useful
Packit fd8b60
to perform the diff from the top level of the tree, e.g.,
Packit fd8b60
Packit fd8b60
    diff -ur src.orig src
Packit fd8b60
Packit fd8b60
It's even more useful if you use our anonymous Subversion repository
Packit fd8b60
at
Packit fd8b60
Packit fd8b60
    svn://anonsvn.mit.edu/krb5
Packit fd8b60
Packit fd8b60
and use "svn diff" (or "svk diff" if you prefer to use SVK) to
Packit fd8b60
generate your patches.
Packit fd8b60
Packit fd8b60
It is much easier for us to integrate patches which are generated
Packit fd8b60
against current code on the trunk.  Please ensure that your source
Packit fd8b60
tree is up-to-date before generating your patch.
Packit fd8b60
Packit fd8b60
COPYRIGHT
Packit fd8b60
=========
Packit fd8b60
Packit fd8b60
If you are submitting substantial quantities of new code, or are
Packit fd8b60
substantially modifying existing code, please be clear about the
Packit fd8b60
copyright status of your contributions.  Note that if your
Packit fd8b60
contribution was created in the course of your employment, your
Packit fd8b60
employer may own copyright in your contribution.
Packit fd8b60
Packit fd8b60
We prefer that MIT receives the ownership of the contributions, but
Packit fd8b60
will generally accept contributed code with copyright owned by other
Packit fd8b60
parties provided that the license conditions are substantially
Packit fd8b60
identical to the existing license on the MIT krb5 code.
Packit fd8b60
Packit fd8b60
Appropriate copyright notices and license terms should be added to new
Packit fd8b60
or changed files, unless the contributed code is being assigned to the
Packit fd8b60
already-listed copyright holder in the file, or the contribution is
Packit fd8b60
being released to the public domain.  Please make sure that the
Packit fd8b60
year in the copyright statement is kept up-to-date.