Release Notes

Helps write notes about changes.

jeromeetienne Updated

File contents

Release notes

Write release notes for the people who use the product.

  1. Find the two versions. If the user does not give them, use the last two git tags.
  2. Read the commits and the merged pull requests between the two versions.
  3. Put each change in one of three groups: New, Changed, Fixed.
  4. Write each change as one sentence that a user can understand. Do not write internal names, file paths, or commit hashes.
  5. Leave out the changes that a user cannot see, such as refactoring and changes to tests.
  6. Start with the version number and the release date.

jeromeetienne/skillmd_opro/tree/main/test_skills/skill_choice/dotagents_folder/skills/release-notes commit d79bca809f

Frequently asked questions

npx skillmds@latest add jeromeetienne/release-notes