From 7762d8796144597c4bdb5f68f51436bf14420ef2 Mon Sep 17 00:00:00 2001 From: Arya Massarat <23412689+aryarm@users.noreply.github.com> Date: Sun, 7 Jan 2024 16:26:30 +0000 Subject: [PATCH] docs: reviewer and maintainer responsibilities with automated releases and PRs --- PUBLISHING.rst | 7 ++++--- README.rst | 2 ++ 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/PUBLISHING.rst b/PUBLISHING.rst index 2673db51..c7dffee2 100644 --- a/PUBLISHING.rst +++ b/PUBLISHING.rst @@ -27,9 +27,10 @@ Publishing Steps To publish a new version of trtools: -1. First, locate the most recent PR prefixed "chore(main)" created by our Github actions bot -2. List a maintainer of our repository (@gymrek-lab/trtools) as a reviewer of the PR and ask them to merge it -3. The bot will automatically create a new version on PyPI and tag a release on Github +1. First, locate the most recent *release PR* prefixed "chore(main)" created by our Github actions bot +2. List a maintainer of our repository (@gymrek-lab/trtools) as a reviewer of the PR +3. The maintainer may edit the auto-generated text-body of the PR release to incorporate additional details from the underlying PRs, if needed +4. Once merged, the bot will automatically create a new version on PyPI and tag a release on Github Lastly, the change needs to be published to bioconda. diff --git a/README.rst b/README.rst index 4c65fbc7..b0f60a52 100644 --- a/README.rst +++ b/README.rst @@ -172,6 +172,8 @@ We appreciate contributions to TRTools. If you would like to contribute a fix or #. Submit a pull request (PR) **to the master branch** of the central repository with a description of what changes you have made. Title the PR according to the `conventional commits spec `_. A member of the TRTools team will reply and continue the contribution process from there, possibly asking for additional information/effort on your part. + * If you are reviewing a pull request, please double-check that the PR addresses each item in `our PR checklist `_ + Publishing ---------- If you are a TRTools maintainer and wish to publish changes and distribute them to PyPI and bioconda, please see PUBLISHING.rst in the root of the git repo.