Hardware Reference
In-Depth Information
Connecting Version Control with Issue Management
The ways you change your code and files to address an issue are collected in the message portion of a commit. These
commits represent progress towards adding features or resolving issues. Connecting this progress to the issue tracking
system is critical because you want to know what the code changes are for and you want to make it easy to track
what code fixed which issue. GitHub has added some automatic linking features that automate part of this process.
If you refer to issues by “#” pound issue number like “#1” in the commit message, or the issue comment GitHub
will automatically link to the corresponding issue number. Every code commit should have the issue number and
description of the code changes. When the issue number is used, GitHub automatically lists the commit in the issue
history. In one issue discussion, you can follow the entire set of changes to code. issue management
Commit hashes are also automatically linked. Every commit has a Secure Hash Algorithm 1 (SHA-1). This hash is
not a sequential number, but a 160 bit unique string, which looks like “f9bf52794286cd2acf664f8ffd7d7547c1b4dfea,”
and which is automatically linked to the commit by GitHub. This makes it easier to discuss multiple commits and
peak at what was changed.
Documentation
Documentation is important. It is critical that you document what you do. When a project moves from one person who
can control everything to a community of users and developers, it is important that people can find out how to use what
you do, and the best way to help improve or enhance your work. It is possible to put all of your documentation into a
readme file or into a documentation directory for the project, but it can be more convenient to use the GitHub wiki. Here
is the quick and dirty way to use GitHub. Select the Wiki Tab on the project as shown in Figure
2-24
.
Figure 2-24.
Github wiki
The default page is called Home and is automatically filled with the text “Welcome to the HelloGithub wiki!” From
here, you can select Edit Page, and enter a main description and provide links to other important project pages.
Creating Pages
The Create and Edit buttons are located on the left side of the wiki page. To create pages, click the New Page button,
and you'll be presented with the Create New Page dialog, as shown in Figure
2-25
.
