Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CHANGELOGs #34

Closed
3 tasks done
tajmone opened this issue Aug 30, 2020 · 0 comments
Closed
3 tasks done

Add CHANGELOGs #34

tajmone opened this issue Aug 30, 2020 · 0 comments
Labels
⭐ changelog Topic: CHANGELOG

Comments

@tajmone
Copy link
Owner

tajmone commented Aug 30, 2020

Now that we are updating the project we need to add a CHANGELOG.

  • In README.md add a new "Changelog" section listing all the significant changes to the repository — grouped by version and/or date.
  • In archived/README.md add new "Changelog" section listing all changes to PML Spec documents, grouped by version releases, and then by document locale.

The idea behind keeping two different changelogs is that the one in the main README should provide info about changes in the repository (e.g. under "August 2020" we'll mention the switch to Dart Sass, dependencies updates, etc.), which don't necessarily relate to the PML Spec documents.

Changes to the PML Spec documents should be documented in the archived/ folder's README, which contains a copy of every document released.

This separation of changelogs is better for all users — maintainers and contributors — for it allows to focus on specific aspects of the project.

In the future, if the "Changelog" section in the main README becomes too long, we can move it to a separate CHANGELOG.md document.

@tajmone tajmone added the ⭐ changelog Topic: CHANGELOG label Aug 30, 2020
@tajmone tajmone added this to the PML Spec v1.1.1 (EN+IT) milestone Aug 30, 2020
@tajmone tajmone mentioned this issue Aug 30, 2020
24 tasks
tajmone added a commit that referenced this issue Sep 13, 2020
Edit `archived/README.md`: (See #31)

- List new HTML docs of PML Spec v1.1.1.
- Add a Changelog with the history of the Spec docs. (See #34)
tajmone added a commit that referenced this issue Sep 13, 2020
In main README:

- Add the "What's New" section listing major changes to
  the repository across the various releases. (fixes #34, see #31)
- Add new "Acknowledgments" section, and credit @RBastianini for all his
  support in the documents revision.
- Update the version badge to `v1.1.1`. (see #31)

The branch `dev1.1.1` is now ready to be squashed into `master` for
the `v1.1.1` release.
@tajmone tajmone closed this as completed Sep 13, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
⭐ changelog Topic: CHANGELOG
Projects
None yet
Development

No branches or pull requests

1 participant