search

php-pds / skeleton

Standard PHP package skeleton.
Creative Commons Attribution Share Alike 4.0 International
2.3k stars 167 forks source link

Add a recommendation to follow the format from Keep a Changelog #18

Closed Revisor closed 7 years ago

pmjones commented 7 years ago

(/me nods along with @Revisor)

Yeah, I get this.

Even so, I am wary of making recommendations, however sensible, that are not backed by the research in some fashion. E.g., licensing, which seems an obvious no-brainer, is not strictly supported by the analysis. (See #1, which ends up adding a SHOULD for a license file.)

Revisor commented 7 years ago

PDS could recommend a few best practices (semver, structured changelog), what do you think?

For semver, there is an argument in form of Composer, which is built around it. For a changelog format, I don't know. It's just sensible in itself. :)

pmjones commented 7 years ago

For the changelog stuff, there is a way forward that can be supported by research, but it would require some effort. You would need to identify the packages using a changelog, go to their repos, examine the file in question, determine if it matches a particular format, then tally the package/format counts. That would give some support to a recommendation.

pmjones commented 7 years ago

Closing this as "not supported by the existing research."

However, due to the versioned nature of the publications, further research might reveal that Keep A Changelog is the most common format, in which case a minor version with a "MAY" or "SHOULD" can be added.

Regardless, thanks for the suggestion.