From 2b024aac7ddb426a0c1b4385a705e1ab21ae8de2 Mon Sep 17 00:00:00 2001 From: Martin Yeo <40734014+trexfeathers@users.noreply.github.com> Date: Thu, 22 Feb 2024 15:30:23 +0000 Subject: [PATCH] Update documentation for the new v5 CLA. (#5664) --- docs/src/common_links.inc | 5 +++-- .../developers_guide/contributing_ci_tests.rst | 11 ++++++----- .../contributing_documentation_easy.rst | 7 ++++--- .../contributing_getting_involved.rst | 16 ++++++++-------- 4 files changed, 21 insertions(+), 18 deletions(-) diff --git a/docs/src/common_links.inc b/docs/src/common_links.inc index 73f7a95e10..476796396f 100644 --- a/docs/src/common_links.inc +++ b/docs/src/common_links.inc @@ -8,8 +8,8 @@ .. _cirrus-ci: https://cirrus-ci.com/github/SciTools/iris .. _codespell: https://github.com/codespell-project/codespell .. _conda: https://docs.conda.io/en/latest/ -.. _contributor: https://github.com/SciTools/scitools.org.uk/blob/master/contributors.json -.. _core developers: https://github.com/SciTools/scitools.org.uk/blob/master/contributors.json +.. _contributor: https://github.com/SciTools/iris/graphs/contributors +.. _core developers: https://github.com/orgs/SciTools/teams/iris-devs/members .. _generating ssh keys for GitHub: https://docs.github.com/en/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account .. _GitHub Actions: https://docs.github.com/en/actions .. _GitHub Help Documentation: https://docs.github.com/en/github @@ -45,6 +45,7 @@ .. _python-stratify: https://github.com/SciTools/python-stratify .. _iris-esmf-regrid: https://github.com/SciTools-incubator/iris-esmf-regrid .. _netCDF4: https://github.com/Unidata/netcdf4-python +.. _SciTools Contributor's License Agreement (CLA): https://cla-assistant.io/SciTools/ .. comment diff --git a/docs/src/developers_guide/contributing_ci_tests.rst b/docs/src/developers_guide/contributing_ci_tests.rst index 799e3fc1c0..542178c2ff 100644 --- a/docs/src/developers_guide/contributing_ci_tests.rst +++ b/docs/src/developers_guide/contributing_ci_tests.rst @@ -92,12 +92,11 @@ Iris target branch by a core developer. .. _testing_cla: -SciTools CLA Checker -******************** +`CLA Assistant`_ +**************** -A bot which checks that the GitHub author of the pull-request has signed the -**SciTools Contributor's License Agreement (CLA)**. For more information on -this please see https://scitools.org.uk/organisation.html#governance. +A bot which checks that the GitHub authors of the pull-request have signed the +|SciTools Contributor's License Agreement (CLA)|_. .. _pre_commit_ci: @@ -147,4 +146,6 @@ For more information on how to use `ruff`_ please see the `ruff documentation`_. .. _.pre-commit-config.yaml: https://github.com/SciTools/iris/blob/main/.pre-commit-config.yaml .. _pre-commit.ci dashboard: https://results.pre-commit.ci/repo/github/5312648 +.. _CLA Assistant: https://github.com/cla-assistant/cla-assistant +.. |SciTools Contributor's License Agreement (CLA)| replace:: **SciTools Contributor's License Agreement (CLA)** .. _ruff documentation: https://docs.astral.sh/ruff/tutorial/ diff --git a/docs/src/developers_guide/contributing_documentation_easy.rst b/docs/src/developers_guide/contributing_documentation_easy.rst index 51554f9e19..a0513fe560 100755 --- a/docs/src/developers_guide/contributing_documentation_easy.rst +++ b/docs/src/developers_guide/contributing_documentation_easy.rst @@ -1,4 +1,6 @@ +.. include:: ../common_links.inc + .. _contributing.documentation_easy: Contributing to the Documentation (the easy way) @@ -15,11 +17,10 @@ the improvement yourself)! First Time Only Steps ^^^^^^^^^^^^^^^^^^^^^ - + 1. Create a `GitHub `_ account. -2. Complete the Scitools Contributor License Agreement (`link to Google Form - `_). +2. Complete the `SciTools Contributor's License Agreement (CLA)`_. This is a one-off requirement for anyone who wishes to contribute to a Scitools repository - including the documentation. diff --git a/docs/src/developers_guide/contributing_getting_involved.rst b/docs/src/developers_guide/contributing_getting_involved.rst index 6ade098b6b..9da6cd13eb 100644 --- a/docs/src/developers_guide/contributing_getting_involved.rst +++ b/docs/src/developers_guide/contributing_getting_involved.rst @@ -22,9 +22,12 @@ Alternatively, **join the conversation** in Iris `GitHub Discussions`_, when you would like the opinions of the Iris community. A `pull request`_ may also be created by anyone who has become a -**contributor** to Iris_. Permissions to merge pull requests to the -``main`` branch are only given to **core developers** of Iris_, this is -to ensure a measure of control. +|contributor|_ to Iris_. Permissions to merge pull requests to the +``main`` branch are only given to |core developers|_ of Iris_, this is +to ensure a measure of control. All authors on a pull request will +automatically be asked to sign the +`SciTools Contributor's License Agreement (CLA)`_, if they have not already +done so. To get started we suggest reading recent `issues`_, `GitHub Discussions`_ and `pull requests`_ for Iris. @@ -32,12 +35,9 @@ To get started we suggest reading recent `issues`_, `GitHub Discussions`_ and If you are new to using GitHub we recommend reading the `GitHub getting started`_ -.. note:: For more information on becoming a contributor_ including a link to - the Contributors Licence Agreement (CLA) see the - `Governance `_ - section of the `SciTools`_ ogranization web site. - .. _GitHub getting started: https://docs.github.com/en/github/getting-started-with-github +.. |contributor| replace:: **contributor** +.. |core developers| replace:: **core developers** .. toctree::