diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c709170..542a811 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -31,15 +31,16 @@ The `develop` branch is the development branch which means it contains the next 1. Branch: Starting from `develop`, cut a release branch named `release/X.Y.Z` for your changes. 1. Version bump: Bump the version number in `insert-special-characters.php`, `readme.txt`, and `package.json` if it does not already reflect the version being released. 1. Update packages: Run `npm update` so that `package-lock.json` gets updated from the version bump in `package.json` in the previous step as well as handle various available dependency updates. -1. Changelog: Add/update the changelog in `CHANGELOG.md` and `readme.txt` -1. Props: update `CREDITS.md` file with any new contributors, confirm maintainers are accurate +1. Changelog: Add/update the changelog in `CHANGELOG.md` and `readme.txt`. +1. Props: update `CREDITS.md` file with any new contributors, confirm maintainers are accurate. 1. New files: Check to be sure any new files/paths that are unnecessary in the production version are included in `.distignore`. 1. Readme updates: Make any other readme changes as necessary. `README.md` is geared toward GitHub and `readme.txt` contains WordPress.org-specific content. The two are slightly different. -1. Merge: Make a non-fast-forward merge from your release branch to `develop` (or merge the pull request), then do the same for `develop` into `trunk` (`git checkout trunk && git merge --no-ff develop`). `trunk` contains the stable development version. -1. Push: Push your `trunk` branch to GitHub, e.g. `git push origin trunk`. -1. Test the pre-release ZIP locally by downloading it from the **Build release zip** action artifact to ensure the plugin doesn't break after release. +1. Merge: Make a non-fast-forward merge from your release branch to `develop` (or merge the pull request), then do the same for `develop` into `trunk`, ensuring you pull the most recent changes into `develop` first (`git checkout develop && git pull origin develop && git checkout trunk && git merge --no-ff develop`). `trunk` contains the stable development version. +1. Push: Push your `trunk` branch to GitHub, (e.g. `git push origin trunk`). +1. [Compare](https://github.com/10up/insert-special-characters/compare/trunk...develop) `trunk` to `develop` to ensure no additional changes were missed. +1. Test the pre-release ZIP locally by [downloading](https://github.com/10up/insert-special-characters/actions/workflows/build-release-zip.yml) it from the Build release zip action artifact and installing it locally. Ensure this zip has all the files we expect, that it installs and activates correctly and that all basic functionality is working. 1. Release: Create a [new release](https://github.com/10up/insert-special-characters/releases/new), naming the tag and the release with the new version number, and targeting the `trunk` branch. Paste the changelog from `CHANGELOG.md` into the body of the release and include a link to the closed issues on the milestone (e.g. `https://github.com/10up/insert-special-characters/milestone/2?closed=1`). 1. SVN: Wait for the [GitHub Action](https://github.com/10up/insert-special-characters/actions) to finish deploying to the WordPress.org repository. If all goes well, users with SVN commit access for that plugin will receive an emailed diff of changes. -1. Check WordPress.org: Ensure that the changes are live on https://wordpress.org/plugins/insert-special-characters/. This may take a few minutes. +1. Check WordPress.org: Ensure that the changes are live on [WordPress.org](https://wordpress.org/plugins/insert-special-characters/). This may take a few minutes. 1. Close milestone: Edit the [milestone](https://github.com/10up/insert-special-characters/milestone/#) with release date (in the `Due date (optional)` field) and link to GitHub release (in the `Description` field), then close the milestone. 1. Punt incomplete items: If any open issues or PRs which were milestoned for `X.Y.Z` do not make it into the release, update their milestone to `X.Y.Z+1`, `X.Y+1.0`, `X+1.0.0` or `Future Release`.