From 78cb39abe1cb9967d3ca99f24883c21f912196d4 Mon Sep 17 00:00:00 2001 From: Natalie Zelenka Date: Tue, 3 May 2022 15:56:29 +0100 Subject: [PATCH 1/7] Create CONTRIBUTING.md --- 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 00000000..f83668cc --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,41 @@ +# Contributing + +Thank you for being interested in contributing to this project! +Data Ethics Club is a community of people who care about data ethics, and we wabt everyone to feel welcome here. + +Check out [the website's Contribution Guide](https://dataethicsclub.com/contents/join_in/contributing.html) for details on how to contribute. + + + +--- +[issues]: https://github.com/very-good-science/data-hazards/issues +[dec-email]: grp-ethicaldatascience@groups.bristol.ac.uk From 3931f9dfe5d85652e7040d0ff6be14ca0c44b70a Mon Sep 17 00:00:00 2001 From: Natalie Zelenka Date: Tue, 3 May 2022 17:07:41 +0100 Subject: [PATCH 2/7] Update contributing.md --- site/contents/join_in/contributing.md | 85 ++++++++++++++++++++++++--- 1 file changed, 77 insertions(+), 8 deletions(-) diff --git a/site/contents/join_in/contributing.md b/site/contents/join_in/contributing.md index 2428e6e2..3fe17a0d 100644 --- a/site/contents/join_in/contributing.md +++ b/site/contents/join_in/contributing.md @@ -1,23 +1,53 @@ # Contributing to our materials -The Data Ethics Club [repository](https://github.com/very-good-science/data-ethics-club) is a hub of information where we collect the discussions we've had as a group, our reading list and information about our past or upcoming meetings. -Our aim is for anyone to feel +The Data Ethics Club [repository][repo] is a hub of information where we collect the discussions we've had as a group, our reading list, information about our past or upcoming meetings, and advice on running your own online journal club. + +The Data Hazards project is always welcoming new contributors! This page gives you an overview of how you can get involved. You can see all of our wonderful existing contributors [on the front page of this website](https://dataethicsclub.com/index.html#our-community). + +We strongly welcome first-time GitHub users and are very happy to provide support if you would like to learn how to edit the repository. Please just get in touch by [email][dec-email] if that is the case. ## What kinds of contributions are we looking for? -We're open to any suggestions on how to improve the Data Ethics Club resources, from increasing accessibility to changing the structure of our content. -That said, we are particuarly open to additions for our [reading list](../reading-list) - the data ethics landscape is pretty huge and so its a group effort keeping on top of new pieces and issues to consider. We welcome videos, blog posts, white papers or journal articles relating to ethics and data science - these can cover anything from be the impact of algorithms on the people who are deploying them, to the ethics of surveillance and buying/selling personal data, to a more technical paper on the specifics of an explainable AI algorithm. +We're open to any suggestions on how to improve the Data Ethics Club resources, from increasing [accessibility][accessibility] to changing the structure of our content. + +That said, we are particuarly open to additions for our **[reading list](../reading-list)** - the data ethics landscape is pretty huge and so its a group effort keeping on top of new pieces and issues to consider. We welcome videos, blog posts, white papers or journal articles relating to ethics and data science - these can cover anything from be the impact of algorithms on the people who are deploying them, to the ethics of surveillance and buying/selling personal data, to a more technical paper on the specifics of an explainable AI algorithm. + +Usually if you are contributing to the reading list we will ask you to also provide three discussion points about the piece to help guide our discussion if we read (or watch/listen to) it for a Data Ethics Club meeting. You can look at our past meetings for an idea of the kinds of questions we consider. + +```{admonition} Choosing accessible reading +:class: tip +:name: choosing-accessible-reading + +Our aim with Data Ethics Club is to provide an [accessible][] and interdisciplinary space where people can think about data science and ethics and discuss it together. + +With this in mind, we have the following guidelines for choosing reading: +- Materials should be short enough to read/watch/listen to in an hour (maximum). If you suggest a longer piece, we will include it in the reading list, but won't include it in a meeting until we've identified a smaller part of the piece to discuss. +- Try to avoid closed access articles. + +If you have further suggestions for choosing accessible reading, we'd love to hear them via [GitHub][new-issue] or [email][dec-email] +``` ## How can I contribute? We accept contributions in a variety of ways. You could: * [Get in touch with us over email or Twitter](../contact) -* Make a Pull Request to our repository -* Open an issue with our [issue template](https://github.com/very-good-science/data-ethics-club/issues/new?assignees=NatalieThurlby&labels=reading+suggestion&template=reading-suggestion.md&title=%5BSUGGESTION%28S%29%5D+You+suggestion%28s%29+here). +* [Make a Pull Request](https://github.com/very-good-science/data-ethics-club/pulls) to [our repository][repo] - instructions {ref}`below`. +* Open an issue + - To suggest some discussion material use [this issue template](https://github.com/very-good-science/data-ethics-club/issues/new?assignees=NatalieZelenka&labels=reading+suggestion&template=reading-suggestion.md&title=%5BSUGGESTION%28S%29%5D+You+suggestion%28s%29+here). + - To suggest anything else, use [a blank issue][new-issue]. We welcome any form of contribution so don't worry if you do not use GitHub, just get in touch with us however works for you and we'll be happy to hear from you. -Usually if you are contributing to the reading list we will ask you to also provide three discussion points about the piece to help guide our discussion if we read (or watch/listen to) it for a Data Ethics Club meeting. You can look at our past meetings for an idea of the kinds of questions we consider. +```{admonition} Writing accessible content +:class: tip +:name: writing-accessible-content + +We want the content on our website to be [accessible][accessible]. For this reason, we: +- Use alt text on all images. See a guide to writing alt-text [here](https://supercooldesign.co.uk/blog/how-to-write-good-alt-text). +- [Check](https://www.color-blindness.com/coblis-color-blindness-simulator/) any images included on the site for colour-blind friendliness. + +If you have further suggestions for writing accessible content, we'd love to hear them via [GitHub][new-issue] or [email][dec-email] +``` ## Credit for contributors @@ -25,4 +55,43 @@ While there is a smaller group of people who send the emails and welcome people Whether they have made suggestions to our reading list, Pull Requests to our GitHub repository, or firey hot takes in our discussions: thank you to each and every one of them! We try to record all of these contributions [on our GitHub repository](https://github.com/very-good-science/data-ethics-club#contributors-). When you suggest something to us please let us know your GitHub username or a link to your personal site so that we can credit you, if you'd like us to. -If you have not been properly credited, please let us know [via email](mailto:grp-ethicaldatascience@groups.bristol.ac.uk), or by commenting on [this GitHub issue](https://github.com/very-good-science/data-ethics-club/issues/38) and tagging one our GitHub usernames (e.g. `@NatalieThurlby`). \ No newline at end of file +If you have not been properly credited, please let us know [via email](mailto:grp-ethicaldatascience@groups.bristol.ac.uk), or by commenting on [this GitHub issue](https://github.com/very-good-science/data-ethics-club/issues/38) and tagging one our GitHub usernames (e.g. `@NatalieZelenka`). + + + +(pr-instructions)= +## Contributing via Pull Request on GitHub + +Here we have some guidelines for making your first GitHub contribution to Data Ethics Club a good experience. + +If you think of something you'd like to work on, then first: +1. Check if there is an existing [issue][issues] describing the issue. If not, make a new one :). +1. Comment on the issue before you start working to let us know you'll be working on it, this helps us not to repeat work and gives and opportunity to discuss how to make your contribution most useful. +2. [Fork](https://help.github.com/articles/fork-a-repo) this repository to your own GitHub account +3. Check that you are happy with the changes by [building the site locally](#build-the-site-locally). +4. Then, once you've made your changes, submit a [pull request](https://help.github.com/articles/creating-a-pull-request): we'll review it as quick as we can 😄. + +### Build the site locally +In order to build the site locally, you'll need to run the following from your root directory: +`sphinx-build site/ site/_build/` + +These require some Python packages to run. +You may want to set up a [virtual environment](https://docs.python.org/3/library/venv.html) first, so that you don't install these packages system-wide. +Then you can install the packages using `pip install -r requirements.txt` + + +--- +[repo]: https://github.com/very-good-science/data-ethics-club/ +[issues]: https://github.com/very-good-science/data-ethics-club/issues +[new-issue]: https://github.com/very-good-science/data-ethics-club/issues/new?assignees=NatalieZelenka +[dec-email]: grp-ethicaldatascience@groups.bristol.ac.uk +[accessibility]: https://dataethicsclub.com/contents/how_to/accessibility-plan.html From 481a3105527ae56dc4b8d23c77488a2ec4b7503c Mon Sep 17 00:00:00 2001 From: Natalie Zelenka Date: Tue, 3 May 2022 17:09:05 +0100 Subject: [PATCH 3/7] Update meeting-structure.md fixing capitalisation of title --- site/contents/how_to/meeting-structure.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/contents/how_to/meeting-structure.md b/site/contents/how_to/meeting-structure.md index 33446dc7..4bba4c1a 100644 --- a/site/contents/how_to/meeting-structure.md +++ b/site/contents/how_to/meeting-structure.md @@ -1,4 +1,4 @@ -# Data Ethics Club Meeting Structure +# Data Ethics Club meeting structure This an outline of how we usually structure meetings. Meetings are typically 1 hour. From ff5e6eac44dd19182a6f1769f1e73ead92af32ed Mon Sep 17 00:00:00 2001 From: Natalie Zelenka Date: Tue, 3 May 2022 17:20:43 +0100 Subject: [PATCH 4/7] Create accessibility-plan --- site/contents/how_to/accessibility-plan | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 site/contents/how_to/accessibility-plan diff --git a/site/contents/how_to/accessibility-plan b/site/contents/how_to/accessibility-plan new file mode 100644 index 00000000..8f463cf9 --- /dev/null +++ b/site/contents/how_to/accessibility-plan @@ -0,0 +1,9 @@ +# Accessibility + +We want everyone to feel welcome to both attend and contribute to Data Ethics Club. +We currently take the following actions to ensure this, but we are always looking for more ways to make Data Ethics Club accessible and we would love your feedback. + From 4f852398c5643429090d870e3028cee91747a8aa Mon Sep 17 00:00:00 2001 From: Nina Di Cara Date: Thu, 5 May 2022 18:09:53 +0100 Subject: [PATCH 5/7] Add items to accessibility and inclusivity plans --- site/contents/how_to/accessibility-plan | 29 ++++++++++++++++++++----- 1 file changed, 23 insertions(+), 6 deletions(-) diff --git a/site/contents/how_to/accessibility-plan b/site/contents/how_to/accessibility-plan index 8f463cf9..a1621941 100644 --- a/site/contents/how_to/accessibility-plan +++ b/site/contents/how_to/accessibility-plan @@ -1,9 +1,26 @@ -# Accessibility +# Accessibility and Inclusivity We want everyone to feel welcome to both attend and contribute to Data Ethics Club. -We currently take the following actions to ensure this, but we are always looking for more ways to make Data Ethics Club accessible and we would love your feedback. - From 0853af548d29f77673e7eb833d4f4813a8542afa Mon Sep 17 00:00:00 2001 From: Nina Di Cara Date: Thu, 5 May 2022 18:10:31 +0100 Subject: [PATCH 6/7] Add .md to filename --- .../contents/how_to/{accessibility-plan => accessibility-plan.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename site/contents/how_to/{accessibility-plan => accessibility-plan.md} (100%) diff --git a/site/contents/how_to/accessibility-plan b/site/contents/how_to/accessibility-plan.md similarity index 100% rename from site/contents/how_to/accessibility-plan rename to site/contents/how_to/accessibility-plan.md From 4c2a6166a90181262e4babce327ba3a8bddbb2b6 Mon Sep 17 00:00:00 2001 From: Nina Di Cara Date: Thu, 5 May 2022 18:11:58 +0100 Subject: [PATCH 7/7] Add to How To main page TOC --- site/contents/how_to/reuse_dec.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/contents/how_to/reuse_dec.md b/site/contents/how_to/reuse_dec.md index 7bc48cdb..93e60494 100644 --- a/site/contents/how_to/reuse_dec.md +++ b/site/contents/how_to/reuse_dec.md @@ -20,10 +20,10 @@ We also have a series of blank templates mentioned in this guide, ready to be re ```{toctree} :maxdepth: 1 organising.md +accessibility-plan.md meeting-structure.md meeting-todo-list.md howto-allcontributorsbot.md howto-sync-hackmd.md howto-add-writeups.md -