You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
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.
Now that we are updating the project we need to add a CHANGELOG.
README.md
add a new "Changelog" section listing all the significant changes to the repository — grouped by version and/or date.archived/README.md
for the PML Spec docs CHANGELOG.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.The text was updated successfully, but these errors were encountered: