mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-02-03 21:03:42 +01:00
7bd48ca9c7
If an object definition already has an example, we shouldn't try to extend that definition by adding examples derived from the individual properties. Doing so is confusing, and there is no way to inhibit it when it is not desired. It's also not what the RapiDoc viewere does, so we end up with examples being inconsistent. |
||
|---|---|---|
| .. | ||
| appendices/newsfragments | ||
| application_service/newsfragments | ||
| client_server/newsfragments | ||
| identity_service/newsfragments | ||
| internal/newsfragments | ||
| legacy | ||
| push_gateway/newsfragments | ||
| room_versions/newsfragments | ||
| server_server/newsfragments | ||
| header.md | ||
| pyproject.toml | ||
| README.md | ||
Changelogs
Towncrier is used to manage the changelog and keep it up to date. Because of this, updating a changelog is really easy.
Generating the changelog
Please see the release docs for more information.
Creating a new changelog
There are a few places you'll have to update:
/layouts/shortcodes/changelog/changelog-changes.htmlto account for the new changelog./scripts/generate-changelog.shto render the changelog for releases.- Supporting documentation such as the contributing guidelines.