search

exadra37-versioning / explicit-versioning

A specification for Software Releases that care about intentional breaking changes being explicit announced in the versioning schema.
GNU General Public License v3.0
22 stars 5 forks source link

Best Practices for Development and Production Releases #4

Closed Exadra37 closed 7 years ago

Exadra37 commented 7 years ago

Due to this comment it will be good to create a separated documentation file with examples how to use Explicit Versioning for Development releases and Production Releases.

Maybe something like how-to-use.md file should then be linked from the Specification in the README.

colomet commented 7 years ago

if we need to create a how to use file, we are making the system too complicate

Exadra37 commented 7 years ago

The how to use is just to recommend best practices in using it and is in a separated file with exactly the purpose of not cluttering the README that must be only related with establishing the specifications.

And maybe a better title would be best-pratices.md.

colomet commented 7 years ago

@Exadra37 you mean https://software-development-guidelines.github.io/CMSver/VERSIONING.html (under development)

Exadra37 commented 7 years ago

@colomet

No that is not what I have in mind.

I will describe best practices for versioning when:

sapioit commented 7 years ago

In other words, practical examples of it's usage, to maximize the percentage of readers that/who completely gasp the concept.

Exadra37 commented 7 years ago

I will try to outline the best practices to use Explicit Versioning in several stages of the life cycle of Software Development.

Some people hate to read or just read in the diagonal and then start posting questions that clearly show they have not payed attention to what they were reading.

This type of people learn/grasp better with practical examples and having a guide for Best Practices with some examples will help them and others to completely grasp the concept of Explicit Versioning as you @sapioit wisely have said ;)