Skip to content

Latest commit

 

History

History
38 lines (26 loc) · 1.48 KB

README.rst

File metadata and controls

38 lines (26 loc) · 1.48 KB
Root.Metadata Parent Index
Sibling aspects Redundancy Security Smell Spelling

Metadata

This describes any aspect that is related to metadata that is not inside your source code.

Subaspects

Example

Commit message, commit message shortlog, commit message body, etc...

Importance

Writing good documentation on each changes we make on our code is always a good idea because it makes it easy to identify what went wrong, what change breaks things or introduce code smells etc...

How to fix this

Enforcing good committing convention to make things consistence, can be a fix for this.