MithrilJS / MithrilJS/mithril.js
We have two change logs
Open
@tbreuss is already working on this.
Since May 31, 2022.
Area: Documentation
Type: Bug
- Dominant language
- JavaScript
- Stars
- 14.5k
- Forks
- 922
- PR merge metrics
- No merged PRs in 30d
Description
We currently have
- https://github.com/MithrilJS/mithril.js/blob/next/docs/changelog.md, the legacy, hand-curated change log used to generate the docs Web site, and
- https://github.com/MithrilJS/mithril.js/blob/next/docs/recent-changes.md, which is generated by pr-release, but not propagated to the site.
From now on, it would seem reasonable to rely on the automated logs. If pr-release is flexible enough, we could tell it to update changelog.md. If it isn't we can move the old entries to recent-changes.md and special-case that file in the build-docs script to put its content in https://mithril.js.org/changelog.html.
Edit, actually, https://mithril.js.org/recent-changes.html is live, but not linked to from anywere.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.