Contributing

Git Commit Messages

Format

Because we have a number of contributors, we want to make sure that the goal and content of code changes are clear just from the git commit summary. Git commit messages should adhere to the following template:

[Issue Number]: Title

[Problem]
State problem and impact

[Solution]
Describe and justify solution

[Test]
Describe automated/manual testing

For example:

Issue-19: Update main page to have welcome information
[Problem]
The main page had the default information from a RapidSMS installation. Additionally, people will need to be trained on
how to use the website, thus adding the basic information to the welcome page would be helpful.

[Solution]
Add basic information about the SMS Alert System and how to use the SMS Alert System website.

[Test]
* python manage.py runserver

Installing the Template

Git supports installing a template file that becomes the initial message on creation of a commit message. The following configures a template for all git commit commands on the local machine:

1. Download the git template file found at Git-Commit-Template and save as ~/.git_commit_msg.txt.
2. Install the template file: git config --global commit.template ~/.git_commit_msg.txt