Skip to content

Commit ee3ee37

Browse files
committed
add periods
1 parent 490bbc4 commit ee3ee37

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

CONTRIBUTING.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ To get started, first `git clone` the [deon repository](https://github.com/drive
1111
### 1. Adding a new item to the examples table
1212

1313
To add an example:
14-
- [ ] Use the [examples table](https://deon.drivendata.org/examples/) to determine the checklist item to which your article applies
15-
- [ ] Add the example to the `examples_of_ethical_issues.yml` file
16-
- [ ] Open a pull request with the change to the yaml file
14+
- [ ] Use the [examples table](https://deon.drivendata.org/examples/) to determine the checklist item to which your article applies.
15+
- [ ] Add the example to the `examples_of_ethical_issues.yml` file.
16+
- [ ] Open a pull request with the change to the yaml file.
1717

1818
#### How to edit the examples table yaml
1919

@@ -37,17 +37,17 @@ Given [our defined perspective on the checklist](#background-and-perspective), w
3737
As part of deon's goal to provide concrete, actionable reminders of the influence of data scientists' choices on the ethics of data science projects, each addition to to the checklist must be accompanied by an example.
3838

3939
The steps for this contribution are:
40-
- [ ] Edit the `checklist.yml` file
41-
- [ ] Add an example to the `examples_of_ethical_issues.yml` file
42-
- [ ] Open a PR that follows the guidelines below
40+
- [ ] Edit the `checklist.yml` file.
41+
- [ ] Add an example to the `examples_of_ethical_issues.yml` file.
42+
- [ ] Open a PR that follows the guidelines below.
4343

4444
#### How to edit the checklist yaml
4545

4646
Navigate to the section of [`deon/assets/checklist.yml`](https://github.com/drivendataorg/deon/blob/main/deon/assets/checklist.yml) where your addition or change applies (e.g. Data Storage). Then follow the format of the other checklist items in making your contribution:
4747

4848
- [ ] Create a new bullet in the `lines` section for that `line_id`, following the format of other checklist items. Ensure the numbering of all line_ids in the section is sequential.
49-
- [ ] After `line_summary`, describe the topic of your question in a few words
50-
- [ ] After `line`, add the new checklist question
49+
- [ ] After `line_summary`, describe the topic of your question in a few words.
50+
- [ ] After `line`, add the new checklist question.
5151

5252
#### How to edit the examples table yaml
5353

@@ -65,7 +65,7 @@ The description in the pull request must include:
6565
- A consideration of related items that already exist, and why this change is different from what exists
6666
- A published example (academic or press article) of where neglecting the principle has lead to concrete harm (articles that discuss potential or hypothetical harm will not be considered sufficient)
6767

68-
## Release Process (for maintainers)
68+
## Release process (for maintainers)
6969

7070
The [`release`](https://github.com/drivendataorg/deon/blob/main/.github/workflows/release.yml) GitHub Actions workflow automates the process of releasing a new version of `deon`.
7171

0 commit comments

Comments
 (0)