From 92e8d78a3db530f76c11188a9dc8a543d03b6fbb Mon Sep 17 00:00:00 2001 From: fenn-cs Date: Thu, 18 Nov 2021 11:46:01 +0100 Subject: [PATCH] stronger language for adding contributors & make commands stand out Signed-off-by: fenn-cs --- README.rst | 5 +++-- docs/release-checklist.rst | 18 ++++++++++++------ 2 files changed, 15 insertions(+), 8 deletions(-) diff --git a/README.rst b/README.rst index 20748a8db..0b73b520e 100644 --- a/README.rst +++ b/README.rst @@ -95,12 +95,13 @@ As a community-driven open source project, Tahoe-LAFS welcomes contributions of - `Patch reviews `__ -Before authoring or reviewing a patch, please familiarize yourself with the `Coding Standard `__ and the `Contributor Code of Conduct `__. +Before authoring or reviewing a patch, please familiarize yourself with the `Coding Standard `__ and the `Contributor Code of Conduct `__. + 🥳 First Contribution? ---------------------- -If you are committing to Tahoe for the very first time, consider adding your name to our contributor list in `CREDITS `__ +If you are committing to Tahoe for the very first time, it's required that you add your name to our contributor list in `CREDITS `__. Please ensure that this addition has it's own commit within your first contribution. 🤝 Supporters diff --git a/docs/release-checklist.rst b/docs/release-checklist.rst index 403a6f933..3f075dd34 100644 --- a/docs/release-checklist.rst +++ b/docs/release-checklist.rst @@ -17,7 +17,7 @@ This checklist is based on the original instructions (in old revisions in the fi Any Contributor -``````````````` +--------------- Anyone who can create normal PRs should be able to complete this portion of the release process. @@ -50,7 +50,11 @@ previously generated files. practice to give it the release name. You MAY also discard this directory once the release process is complete.* -- ``cd`` into the release directory and install dependencies by running ``python -m venv venv && source venv/bin/activate && pip install --editable .[test]`` +Get into the release directory and install dependencies by running + +- ``cd ../tahoe-release-x.x.x`` (assuming you are still in your original clone) +- ``python -m venv venv`` +- ``./venv/bin/pip install --editable .[test]`` Create Branch and Apply Updates @@ -137,16 +141,18 @@ they will need to evaluate which contributors' signatures they trust. - build all code locally - these should all pass: - - tox -e py27,codechecks,docs,integration + - ``tox -e py27,codechecks,docs,integration`` - these can fail (ideally they should not of course): - - tox -e deprecations,upcoming-deprecations + - ``tox -e deprecations,upcoming-deprecations`` - build tarballs - tox -e tarballs - - Confirm that release tarballs exist by runnig: ``ls dist/ | grep 1.16.0rc0`` + - Confirm that release tarballs exist by runnig: + + - ``ls dist/ | grep 1.16.0rc0`` - inspect and test the tarballs @@ -160,7 +166,7 @@ they will need to evaluate which contributors' signatures they trust. Privileged Contributor -`````````````````````` +----------------------- Steps in this portion require special access to keys or infrastructure. For example, **access to tahoe-lafs.org** to upload