Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Text files were normalized to use LF in commit 5275b...  Any existing branches/tags that are not normalized may contain a mix of files.  Merging changes from a crlf file into a normalized branch may be problematic. In particular, merging any modified crlf file into its normalized counterpart will produce a conflict with a whole-file diff (i.e. it will appear as the entire file is in conflict).   Converting any such files to use LF endings in the originating (old) branch is a reasonable solution, and will result in merges that behave as expected.

Commit Messages

Commit messages should follow the guidelines described in detail at http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html.

In summary:

  • First line: JIRA issue ID in all caps (if applicable), followed by a brief description (~ 50 characters)
  • Blank line
  • Third line: more detailed description, line-wrapped at 72 characters. Link to JIRA issue, if applicable.

Use the present tense when writing messages, i.e. "Fix bug, apply patch", not "Fixed bug, applied patch."

Two sample commit messages

  • linked to a JIRA issue:
    Code Block
    FCREPO-780: NPE thrown on disseminations
    
    Fix for the following bug: Fedora throws a null pointer exception if 
    you call a disseminator that fronts a web service whose response does 
    not contain a "Content-type" header.
    
    https://jira.duraspace.org/browse/FCREPO-780
    
  • general issue:
    Code Block
    Create .gitattributes file to normalize line feeds
    
    Create .gitattributes file requesting all text files normalised to LF.
    Will be ignored by git versions < 1.7.2
    
    See https://wiki.duraspace.org/display/FCREPO/Git+Guidelines+and+Best+Practices
    for more information.