Skip to content

Commit

Permalink
Merge added detail to the repo about accessibility
Browse files Browse the repository at this point in the history
This includes accessibility and inclusivity actions we aim to take, added to the How To guides. These were added following feedback from the DEC descriptor paper peer review.
  • Loading branch information
ninadicara authored May 5, 2022
2 parents d004ae6 + 4c2a616 commit db6729b
Show file tree
Hide file tree
Showing 5 changed files with 146 additions and 10 deletions.
41 changes: 41 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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.

<!--
From Data Hazards - we need to adapt these
## *Types* of contribution
Here are some ways to get involved. We would absolutely love your input on the following:
## *How* to contribute
[//]: # (TODO: Have a guide here to the way that the website is organised)
y are a little thin, so if you'd like to help please get in touch with us, please [send us an email][dec-email] and we will help you to find what you're looking for!
### Contributing on GitHub
If you find an [issue][issues] that you'd like to help with, then please:
1. Comment on it before you start working, so we don't repeat work.
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`
-->

---
[issues]: https://github.com/very-good-science/data-hazards/issues
[dec-email]: [email protected]
26 changes: 26 additions & 0 deletions site/contents/how_to/accessibility-plan.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# 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 inclusive and we would love your feedback.

## Accessibility

* Enable closed captioning in our Zoom meetings.
* We would welcome advice on how to make this work for breakout rooms too, please [contact us](../contact) if you have advice.
* Run meetings at times that work well for most people. This tends to be 1-2pm GMT since it lies in the middle of the work day for those in adjacent time-zones, which allows for those who need to do school drop-offs or attend over lunch breaks.
* Enable people to participate in the Zoom meetings via text only.
* Ensure there is alt text ([read about alt-text here](https://moz.com/learn/seo/alt-text)) for all images used on the website.
* Try to make sure that hyperlinks are used in a way that is easy to use with a screen reader. [Read here about why it is important to appropriately label hyperlinks](https://twitter.com/Em1lySm/status/1516741011422199810). (This is something we are still implementing so tell us if you spot somewhere this could be improved!)
* When choosing audio or video discussion items, give preference to items with transcripts and/or closed captioning available.

## Inclusivity

* Share our [Code of Conduct](../join_in/code-of-conduct) at each meeting.
* Aim to have one Data Ethics Club organiser in each break out room in case the Code of Conduct is not adhered to.
* Use gender neutral language by default.
* Assign breakout rooms in meetings randomly so that most people meet someone new each session. This aims to make it less intimidating for new attendees as well as encouraging a broader exposure to different ideas for regular attendees.
* Choose reading items that do not require payment, or provide those that do.

<!-- TODO:
- Guidelines for [choosing accessible reading]()
-->
2 changes: 1 addition & 1 deletion site/contents/how_to/meeting-structure.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion site/contents/how_to/reuse_dec.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
85 changes: 77 additions & 8 deletions site/contents/join_in/contributing.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,97 @@
# 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<pr-instructions>`.
* 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

While there is a smaller group of people who send the emails and welcome people to the event, Data Ethics Club wouldn't be what it is without any one of its contributors.
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:[email protected]), 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`).
If you have not been properly credited, please let us know [via email](mailto:[email protected]), 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`).

<!--
## Directory structure
It can be useful to know what's where in our GitHub repository if you're thinking about making a contribution.
The most important parts of the directory structure are explained here.
```
site
```
-->

(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]: [email protected]
[accessibility]: https://dataethicsclub.com/contents/how_to/accessibility-plan.html

0 comments on commit db6729b

Please sign in to comment.