diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cdcd441a..1955530a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -29,3 +29,33 @@ Consider the following guidelines when preparing to submit a patch: * Ensure that you test your code. Any patches sent in for new / fixed functionality must include tests in order to be merged into master. * If you plan on making any major changes, create an issue before sending a patch. This will allow for proper discussion beforehand. * Keep any os / arch specific code contained to os / arch specific files. Delve leverages Go's filename based conditional compilation, i.e do not put Linux specific functionality in a non Linux specific file. + +### Format of the Commit Message + +We follow a rough convention for commit messages that is designed to answer two +questions: what changed and why. The subject line should feature the what and +the body of the commit should describe the why. + +``` +terminal/command: Add 'list' command + +This change adds the 'list' command which will print either your current +location, or the location that you specify using the Delve linespec. + +Fixes #38 +``` + +The format can be described more formally as follows: + +``` +: + + + +