From 45082b3df6ecbb09d3a0b5d1b65e241ad5fa1c1d Mon Sep 17 00:00:00 2001 From: Sam Cunliffe Date: Mon, 2 Dec 2024 14:24:27 +0000 Subject: [PATCH 1/7] Add a CONTRIBUTING based on UCL-ARC/python-tooling. --- CONTRIBUTING.md | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..040dfcf --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,41 @@ +# Contributing Guide + +This repository is a collection of best practices and coding standards. It has been made by [research +software engineers] at [UCL's Centre for Advanced Research Computing][UCL ARC]. +Some of it is from our internal documentation and recommendations pulled out and made public. +The content is stored in [GitHub flavoured markdown], and is rendered as a live [webpage]. + +Any changes should be reviewed by a member or associate member of ARC. +If the additions are taken from ARC's internal documentation, **please add the original author** as a reviewer to check that they're OK with their content being made public a CC-by-4.0. +If something seems like it's broken, please go ahead and [open an issue]! + +> [!NOTE] +> We're open for contributions from anyone but it's the UCL ARC recommended best-practices, so ulitmately it belongs to the software teams at ARC and we may not adopt suggestions from outside (sorry!). + +## Development workflow + +To contribute a change, please: + +1. Create a new branch (or fork if you're not in [@UCL-ARC/collaborations]). +2. Modify an existing page, or create a new one. + a. Run [pre-commit] which will lint your changes. +3. Open a _pull request_ (PR) with changes. +4. Ask someone who did not contribute to the PR from [@UCL-ARC/collaborations] + to review it. +5. If approved with no comments, then the last approving reviewer should merge the PR. +6. If changes are requested, the PR author should address the comments, and then + ask for review again. + + + + + +[GitHub flavoured markdown]: https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax +[webpage]: http://github-pages.arc.ucl.ac.uk/coding-standards/ +[UCL ARC]: https://ucl.ac.uk/arc +[open an issue]: https://github.com/UCL-ARC/coding-standards/issues/new/choose +[Research software engineers]: https://society-rse.org/about/history +[pre-commit]: https://pre-commit.com +[@UCL-ARC/collaborations]: https://github.com/orgs/UCL-ARC/teams/collaborations + + From db49984108aa99d6362c2171532e2f0bbca4ac8a Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Mon, 2 Dec 2024 14:25:30 +0000 Subject: [PATCH 2/7] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- CONTRIBUTING.md | 25 +++++++++++-------------- 1 file changed, 11 insertions(+), 14 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 040dfcf..1d5f8ec 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,30 +1,27 @@ # Contributing Guide This repository is a collection of best practices and coding standards. It has been made by [research -software engineers] at [UCL's Centre for Advanced Research Computing][UCL ARC]. -Some of it is from our internal documentation and recommendations pulled out and made public. -The content is stored in [GitHub flavoured markdown], and is rendered as a live [webpage]. +software engineers] at [UCL's Centre for Advanced Research Computing][UCL ARC]. Some of it is from our internal +documentation and recommendations pulled out and made public. The content is stored in [GitHub flavoured markdown], and +is rendered as a live [webpage]. -Any changes should be reviewed by a member or associate member of ARC. -If the additions are taken from ARC's internal documentation, **please add the original author** as a reviewer to check that they're OK with their content being made public a CC-by-4.0. -If something seems like it's broken, please go ahead and [open an issue]! +Any changes should be reviewed by a member or associate member of ARC. If the additions are taken from ARC's internal +documentation, **please add the original author** as a reviewer to check that they're OK with their content being made +public a CC-by-4.0. If something seems like it's broken, please go ahead and [open an issue]! -> [!NOTE] -> We're open for contributions from anyone but it's the UCL ARC recommended best-practices, so ulitmately it belongs to the software teams at ARC and we may not adopt suggestions from outside (sorry!). +> [!NOTE] We're open for contributions from anyone but it's the UCL ARC recommended best-practices, so ulitmately it +> belongs to the software teams at ARC and we may not adopt suggestions from outside (sorry!). ## Development workflow To contribute a change, please: 1. Create a new branch (or fork if you're not in [@UCL-ARC/collaborations]). -2. Modify an existing page, or create a new one. - a. Run [pre-commit] which will lint your changes. +2. Modify an existing page, or create a new one. a. Run [pre-commit] which will lint your changes. 3. Open a _pull request_ (PR) with changes. -4. Ask someone who did not contribute to the PR from [@UCL-ARC/collaborations] - to review it. +4. Ask someone who did not contribute to the PR from [@UCL-ARC/collaborations] to review it. 5. If approved with no comments, then the last approving reviewer should merge the PR. -6. If changes are requested, the PR author should address the comments, and then - ask for review again. +6. If changes are requested, the PR author should address the comments, and then ask for review again. From 2ab2120bcd9260525e6f17c16c157d5bf1490189 Mon Sep 17 00:00:00 2001 From: Sam Cunliffe Date: Mon, 2 Dec 2024 14:28:07 +0000 Subject: [PATCH 3/7] Attempt to fix callout. --- CONTRIBUTING.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1d5f8ec..81b0ced 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,7 +9,8 @@ Any changes should be reviewed by a member or associate member of ARC. If the ad documentation, **please add the original author** as a reviewer to check that they're OK with their content being made public a CC-by-4.0. If something seems like it's broken, please go ahead and [open an issue]! -> [!NOTE] We're open for contributions from anyone but it's the UCL ARC recommended best-practices, so ulitmately it +> [!NOTE] +> We're open for contributions from anyone but it's the UCL ARC recommended best-practices, so ulitmately it > belongs to the software teams at ARC and we may not adopt suggestions from outside (sorry!). ## Development workflow From c338f1d1da697e4fc62931bdcbfd29d0bdd6da64 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Mon, 2 Dec 2024 14:28:45 +0000 Subject: [PATCH 4/7] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- CONTRIBUTING.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 81b0ced..1d5f8ec 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,8 +9,7 @@ Any changes should be reviewed by a member or associate member of ARC. If the ad documentation, **please add the original author** as a reviewer to check that they're OK with their content being made public a CC-by-4.0. If something seems like it's broken, please go ahead and [open an issue]! -> [!NOTE] -> We're open for contributions from anyone but it's the UCL ARC recommended best-practices, so ulitmately it +> [!NOTE] We're open for contributions from anyone but it's the UCL ARC recommended best-practices, so ulitmately it > belongs to the software teams at ARC and we may not adopt suggestions from outside (sorry!). ## Development workflow From 8e53255bd2cf836aac014858766268cb1410cd77 Mon Sep 17 00:00:00 2001 From: Sam Cunliffe Date: Mon, 2 Dec 2024 14:34:55 +0000 Subject: [PATCH 5/7] Workaround prettier/prettier/#15479 --- CONTRIBUTING.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1d5f8ec..6ca452a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,8 +9,11 @@ Any changes should be reviewed by a member or associate member of ARC. If the ad documentation, **please add the original author** as a reviewer to check that they're OK with their content being made public a CC-by-4.0. If something seems like it's broken, please go ahead and [open an issue]! -> [!NOTE] We're open for contributions from anyone but it's the UCL ARC recommended best-practices, so ulitmately it + +> [!NOTE] +> We're open for contributions from anyone but it's the UCL ARC recommended best-practices, so ulitmately it > belongs to the software teams at ARC and we may not adopt suggestions from outside (sorry!). + ## Development workflow From 6b0cf7e946cb383f4abc3d0505951602c4d8cd5b Mon Sep 17 00:00:00 2001 From: Sam Cunliffe Date: Wed, 4 Dec 2024 15:07:49 +0000 Subject: [PATCH 6/7] I can English such goodly. Co-authored-by: Milan Malfait <38256462+milanmlft@users.noreply.github.com> --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6ca452a..6cb4bb6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,7 +7,7 @@ is rendered as a live [webpage]. Any changes should be reviewed by a member or associate member of ARC. If the additions are taken from ARC's internal documentation, **please add the original author** as a reviewer to check that they're OK with their content being made -public a CC-by-4.0. If something seems like it's broken, please go ahead and [open an issue]! +public under a CC-by-4.0 license. If something seems like it's broken, please go ahead and [open an issue]! > [!NOTE] From 147b1623010dde17c1a8e1031d52babb8825f0a3 Mon Sep 17 00:00:00 2001 From: "Patrick J. Roddy" Date: Fri, 6 Dec 2024 09:39:44 +0000 Subject: [PATCH 7/7] Adjust `prettier` ignore --- CONTRIBUTING.md | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6cb4bb6..8e17555 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,11 +9,10 @@ Any changes should be reviewed by a member or associate member of ARC. If the ad documentation, **please add the original author** as a reviewer to check that they're OK with their content being made public under a CC-by-4.0 license. If something seems like it's broken, please go ahead and [open an issue]! - + > [!NOTE] > We're open for contributions from anyone but it's the UCL ARC recommended best-practices, so ulitmately it > belongs to the software teams at ARC and we may not adopt suggestions from outside (sorry!). - ## Development workflow @@ -28,14 +27,11 @@ To contribute a change, please: - - -[GitHub flavoured markdown]: https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax +[GitHub flavoured markdown]: + https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax [webpage]: http://github-pages.arc.ucl.ac.uk/coding-standards/ [UCL ARC]: https://ucl.ac.uk/arc [open an issue]: https://github.com/UCL-ARC/coding-standards/issues/new/choose [Research software engineers]: https://society-rse.org/about/history [pre-commit]: https://pre-commit.com [@UCL-ARC/collaborations]: https://github.com/orgs/UCL-ARC/teams/collaborations - -