Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation for the new v5 CLA #5664

Merged
merged 2 commits into from
Feb 22, 2024
Merged

Update documentation for the new v5 CLA #5664

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9cac3c9
Update documentation for the new v5 CLA.
trexfeathers Dec 22, 2023
b7e73ab
Merge branch 'main' into cla_v5
trexfeathers Feb 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/src/common_links.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
ESadek-MO marked this conversation as resolved.
Show resolved Hide resolved
.. _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
Expand Down Expand Up @@ -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
Expand Down
11 changes: 6 additions & 5 deletions docs/src/developers_guide/contributing_ci_tests.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
ESadek-MO marked this conversation as resolved.
Show resolved Hide resolved
A bot which checks that the GitHub authors of the pull-request have signed the
|SciTools Contributor's License Agreement (CLA)|_.


.. _pre_commit_ci:
Expand All @@ -121,3 +120,5 @@ See the `pre-commit.ci dashboard`_ for details of recent past and active Iris jo

.. _.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)**
ESadek-MO marked this conversation as resolved.
Show resolved Hide resolved
7 changes: 4 additions & 3 deletions docs/src/developers_guide/contributing_documentation_easy.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@

.. include:: ../common_links.inc

.. _contributing.documentation_easy:

Contributing to the Documentation (the easy way)
Expand All @@ -15,11 +17,10 @@ the improvement yourself)!

First Time Only Steps
^^^^^^^^^^^^^^^^^^^^^

1. Create a `GitHub <https://github.com/>`_ account.

2. Complete the Scitools Contributor License Agreement (`link to Google Form
<https://docs.google.com/forms/d/e/1FAIpQLSfd0tdE-DcJOXh8ej_7T93IizwJFYBFyRWYQOi2A8QRaKwykA/viewform>`_).
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.

Expand Down
16 changes: 8 additions & 8 deletions docs/src/developers_guide/contributing_getting_involved.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,22 +22,22 @@ 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.

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 <https://scitools.org.uk/organisation.html#governance>`_
section of the `SciTools`_ ogranization web site.

ESadek-MO marked this conversation as resolved.
Show resolved Hide resolved
.. _GitHub getting started: https://docs.github.com/en/github/getting-started-with-github
.. |contributor| replace:: **contributor**
.. |core developers| replace:: **core developers**


.. toctree::
Expand Down
Loading