Headless SDK: Changelog requirements

electrumsv / headless-sdk

Produce bundled portable python distributions ready for executing all SDK components in a fully self-contained way

3 stars 2 forks source link

Headless SDK: Changelog requirements #12

Closed rt121212121 closed 2 years ago

rt121212121 commented 2 years ago

The headless SDK should have a changelog and this should list all the changes in the included subprojects.

This should appear:

As a file in the top-level directory of the distribution.
Pasted in the Github releases entry.

This information should be clear English sentences, and be readable by a technically able person, but not one who necessarily has to be a developer. No pasted commit entries. Changes should be broken up by subproject.

AustEcon commented 2 years ago

Completed in: https://github.com/electrumsv/electrumsv-sdk/commit/754477df848fa041c9d52688dd945cdd5bff3567

I just noticed Roger, re-reading this that you wanted it broken up by subproject. I can still do that if you prefer but I personally think it's not necessary because the volume of changes per SDK version increment is not that much when it's summarized to the main changes.