kenmirrors/MagicMirror
1
0
Fork 0
mirror of https://github.com/MichMich/MagicMirror.git synced 2025-12-12 01:42:19 +00:00
Code Issues Projects Releases Wiki Activity
Files
4186cbf0b258db126c616e180cf34239b106df14
MagicMirror/.github/PULL_REQUEST_TEMPLATE.md
Karsten Hassel 4186cbf0b2 [core] auto create release notes with every push on develop (#3985) 
and remove CHANGELOG.md logic.

This is my attempt to create a draft release instead of editing a
changelog, see discussion on discord.

Logic:
- new github workflow `.github/workflows/release-notes.yaml`
- runs with every push on `develop` (so after PR's are merged)
- collects the commits on `develop` which are newer than the latest tag
- searches the commit messages for keywords defined in an array and
group the messages into categories (this is a first shot, we will update
this ...)
- creates markdown content
- looks for an untagged and unpublished draft release with name
`unreleased`, if it exists, it will be deleted
- creates an untagged and unpublished draft release with name
`unreleased` with markdown content created above

Example created on my fork (this caused having `MagicMirrorOrg` in the
PR-Links):

<img width="952" height="1804" alt="grafik"
src="https://github.com/user-attachments/assets/38687bed-f5da-4dcb-93eb-242c317769df"
/>

Please review this PR, it is a draft release at the moment because I got
problems in my fork where I tested this: The created draft release is
not visible at the moment (they are visible via api). AFAIS this is a
queue problem on GitHub, maybe I flooded their queue while testing ...
So I will test this tomorrow again before removing `draft` here.
2025-12-10 11:56:31 -06:00

941 B
Raw Blame History

Hello and thank you for wanting to contribute to the MagicMirror² project!

Please make sure that you have followed these 3 rules before submitting your Pull Request:

  1. Base your pull requests against the develop branch.
  2. Include these infos in the description:
  • Does the pull request solve a related issue?
  • If so, can you reference the issue like this Fixes #<issue_number>?
  • What does the pull request accomplish? Use a list if needed.
  • If it includes major visual changes please add screenshots.
  1. Please run node --run lint:prettier before submitting so that style issues are fixed.

Note: Sometimes the development moves very fast. It is highly recommended that you update your branch of develop before creating a pull request to send us your changes. This makes everyone's lives easier (including yours) and helps us out on the development team.

Thanks again and have a nice day!