Skip to content

scm.md

Latest commit

 

History

History
43 lines (30 loc) · 1.82 KB

scm.md

File metadata and controls

43 lines (30 loc) · 1.82 KB
Raw

Source Code Management

For this project we are using git as our Version Control System.

Git Flow

For this project we have agreed to follow git flow branching system for our development work.If you are new to git flow please go through this tutorial to learn some basic concepts.

Git flow branch Model

Read more about the diagram here

Commit Message Best Practices

  • Separate subject from body with a blank line.
  • Limit the subject line to 50 characters.
  • Capitalize the subject line.
  • Do not end the subject line with a period.
  • Use the imperative mood in the subject line.
  • Wrap the body at 72 characters.
  • Use the body to explain what and why vs. how.

Examples

  • If applied, this commit will refactor subsystem X for readability.
  • If applied, this commit will update getting started documentation.
  • If applied, this commit will remove deprecated methods.
  • If applied, this commit will release version 1.0.0.
  • If applied, this commit will merge pull request #123 from user/branch.

From the above examples the phase in bold and italic font should be used as the subject in your commit. Remember to observe all the above mentioned commit message best practices.

Read this for further knowledge

References

For these references look at how these teams/Individuals writes their commit messages