Style Guide: git commits

Oliver Beckstein edited this page Sep 27, 2015 · 2 revisions

The guidelines for committing to the MDAnalysis git repository are part of the Style Guide.

  • Check in sets of changes via git. All changes in one revision should have a common theme. If you implemented two rather different things (say, one bug fix and one new feature) then split your check in into two.
  • Always add a descriptive comment (feel free to be verbose).
    • use a short (<50 characters) subject line that summarizes the change
    • leave a blank line
    • optionally, add additional more verbose descriptions; paragraphs or bullet lists (with - or *) are good
    • manually break lines at 80 characters
    • manually indent bullet lists
    • See also Tim Pope's A Note About Git Commit Messages for rationale.

Project Information

About
GNU GPL v2 code license
Labels: python, molecular dynamics, analysis, DCD, CHARMM, LAMMPS, NAMD, Gromacs, computer simulation, atoms, coordinates, trajectory, XTC, Library, object-oriented
Core Developers

Essentials

Applications
Downloads
Install
Release Notes
Guide for Developers
Google Summer of Code

Code of Conduct

Links

@mdanalysis on Twitter
Documentation
Tutorials
Downloads (PyPi)
Mailing Lists:
User discussion group
Developer mailing list

Clone this wiki locally
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.