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

Cleanup: upgrade.txt, README and CHANGES #572

Closed
jrchamp opened this issue Jan 29, 2024 · 0 comments · Fixed by #575
Closed

Cleanup: upgrade.txt, README and CHANGES #572

jrchamp opened this issue Jan 29, 2024 · 0 comments · Fixed by #575
Assignees
Labels
bug Fixes problems or reduces technical debt

Comments

@jrchamp
Copy link
Collaborator

jrchamp commented Jan 29, 2024

From https://moodledev.io/docs/apis/commonfiles#changes

If your plugin includes a changelog in its root directory, this will be used to automatically pre-fill the release notes field when uploading new versions of your plugin to the Plugins directory.

Right now, our changelog is in README.me, but Moodle suggests having that text in CHANGES.md

From https://moodledev.io/docs/apis/commonfiles#upgradetxt

Each component and subsystem may make use of an upgrade.txt file in the top level folder. A section title is used to identify the Moodle version where the change was introduced, and significant changes for that version relating to that component or subsystem are noted.

Although I try to highlight these in the the release notes, noting them in the the upgrade.txt file is the Moodle way to mention significant changes.

@jrchamp jrchamp added the bug Fixes problems or reduces technical debt label Jan 29, 2024
@jrchamp jrchamp self-assigned this Feb 1, 2024
@jrchamp jrchamp linked a pull request Feb 21, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Fixes problems or reduces technical debt
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

1 participant