Do you use version numbers and well formatted notes to keep track of solution changes?

Updated by TiagoAraujo 5 years ago. See history

123
<introEmbed body={<> Dynamics uses a solution as a logical container to hold all customizations for a given function or sub-function. It is very important to have a versioning strategy around changes and when to increment versions. </>} />

Increment the version *every time* a change is made and add a new line at the top of the description field containing:

  1. New version number
  2. Developer initials
  3. Change notes, can changes, removals, additions to the solution

This gives you a quick and easy reference for the changes that have happened in the solution. Following this standard means comparing solutions across environments is a painless process.

❌ Figure: ![Bad Example: Version 1.0.0.0, No changelog](/uploads/rules/use-version-numbers-and-well-formatted-notes-to-keep-track-of-solution-changes/change-log-bad.png)

✅ Figure: ![Good Example: Solution has up to date versioning with detailed changelog](/uploads/rules/use-version-numbers-and-well-formatted-notes-to-keep-track-of-solution-changes/change-log-good.png)

Acknowledgements

Adam Cogan
Mehmet Ozdemir
Related rules

Need help?

SSW Consulting has over 30 years of experience developing awesome software solutions.

We open source.Loving SSW Rules? Star us on GitHub. Star