search

benwiley4000 / cassette

📼 A flexible media player component library for React that requires no up-front config
https://benwiley4000.github.io/cassette/styleguide
MIT License
185 stars 28 forks source link

Needs Changelog.. including extensive v2.0 entry #323

Open benwiley4000 opened 5 years ago

benwiley4000 commented 5 years ago

For the v2 release we'll want a Changelog. We can port release notes from past versions into the changelog as well as document the extensive changes in version 2.

The project of documenting changes in v2 will be a bit tough because so much work has been happening across many separate issues. We'll need to:

  1. Compile a table listing all the GitHub issues and pull requests on this repo, as well as any commits that were made directly to the next branch with no feature branch.
  2. Mark as irrelevant all issues/PRs that were solved in previous releases.
  3. For the remaining items, mark "documentation not needed" any item that is purely concerning a bugfix for an issue that was never released prior to the 2.0 alpha, or any change that was unrelated to the public API.
  4. Go through each of the remaining items where documentation is needed and make an entry in a new table concerning that topic. If multiple items (e.g. an issue and a pull request) concern the same change, don't duplicate it. Each row in the new table should have an ID. In the first table, add a column for the related ID in the second table.
  5. For each topic in the second table, label it with one of the main changelog categories (added, changed, deprecated, removed, fixed, security)
  6. For each topic in the second table, answer the question, "is this a breaking change?"
  7. This should be enough material to create a changelog entry for v2 based on the second table. Each item in the changelog entry should link to the pull request or commit. If the record is a commit to the next branch and no issue number is linked, find the issue on GitHub if available and link that in the item as well. If the record is a pull request and no issue is linked but one exists, go back and add the link to the pull request.
benwiley4000 commented 5 years ago

I'll add this after the beta release goes out, but soon after.

benwiley4000 commented 5 years ago

I have an in-progress spreadsheet with all the commits, issues and pull requests related to the next branch specifically (excluding stuff already in master). https://docs.google.com/spreadsheets/d/12FTjQXnshB0bXvHVh-rmSYDLZkc6MeoHkqcZg_Swn-o/edit?usp=sharing

I've already deselected pull requests and commits that don't need release documentation. I still need to triage the issue list.