Blame doc/contributing.txt

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