From b8763de5fa8aec1fab58520c7f156e61ae072351 Mon Sep 17 00:00:00 2001 From: Dan Birman Date: Mon, 6 Jan 2025 11:59:12 -0800 Subject: [PATCH] Docs add info (#1208) * Update CONTRIBUTING.md * bump schema version [skip actions] * Revert "bump schema version [skip actions]" This reverts commit 15b4676e4df849473ea2b22a3d6f79d875742465. * chore: minor --------- Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com> --- CONTRIBUTING.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 38df76c04..52c665f5d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -102,4 +102,15 @@ where scope (optional) describes the packages affected by the code changes and t - **test**: Adding missing tests or correcting existing tests to set up your environment. -When you are ready to open a pull request, please link any relevant issues and request a review. Thanks for contributing! \ No newline at end of file +When you are ready to open a pull request, please link any relevant issues and request a review. Thanks for contributing! + +## Release + +- From dev, create a branch called release-vX.Y.Z +- Manually increment the version number in the aind_data_schema/__init__.py file to match +- Manually increment the major/minor/patch versions of the core files as needed +- Push the branch and open a PR into main +- After this push, any last minute changes to the release-vX.Y.Z will have to done to via a PR +- After review, use a merge commit to merge into main +- Open a PR from main back into dev so they're synced again +- Create a Github release with the corresponding tag, modify the auto-generated release notes to focus on the major changes that occurred