diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..91be786 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,7 @@ +## Purpose +_Why does this exist?_ + +#### Checklist +- [ ] Added or updated unit tests +- [ ] Added to release notes +- [ ] Updated readme/documentation (if necessary) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5d68c57..f8d04dc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,7 +5,8 @@ ### Added ### Fixed -- Correctly parse message timestamps with a trailing Z UTC indicator +- Decode potential delivery reports as latin1 to prevent encoding-related crashes (#71) +- Correctly parse message timestamps with a trailing Z UTC indicator (#74) ### Changed diff --git a/README.md b/README.md index f29e153..a60600e 100644 --- a/README.md +++ b/README.md @@ -74,3 +74,19 @@ If you're using an editor that supports [LSP](https://microsoft.github.io/langua ``` Configuring LSP depends on your editor. In most cases, the default configuration for the relevant plugin or extension should be suitable. + +## Release process + +To release a new version, follow these steps: + +1. Make sure all relevant PRs are merged and that all necessary QA testing is complete +1. Make sure release notes are up to date and accurate +1. In one commit on the `main` branch: + - Update the version number in `pyproject.toml` to the release version + - Replace the UNRELEASED header in `CHANGELOG.md` with the release version and date +1. Tag the release commit with the release version (for example, `v0.2.1` for version `0.2.1`) +1. Push the release commit and tag +1. In one commit on the `main` branch: + - Update the version number in `pyproject.toml` to the next pre-release version + - Add a new UNRELEASED header in `CHANGELOG.md` +1. Push the post-release commit