You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: CONTRIBUTING.md
+9-9
Original file line number
Diff line number
Diff line change
@@ -11,9 +11,9 @@ To get started, first `git clone` the [deon repository](https://github.com/drive
11
11
### 1. Adding a new item to the examples table
12
12
13
13
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.
17
17
18
18
#### How to edit the examples table yaml
19
19
@@ -37,17 +37,17 @@ Given [our defined perspective on the checklist](#background-and-perspective), w
37
37
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.
38
38
39
39
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.
43
43
44
44
#### How to edit the checklist yaml
45
45
46
46
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:
47
47
48
48
-[ ] 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.
51
51
52
52
#### How to edit the examples table yaml
53
53
@@ -65,7 +65,7 @@ The description in the pull request must include:
65
65
- A consideration of related items that already exist, and why this change is different from what exists
66
66
- 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)
67
67
68
-
## Release Process (for maintainers)
68
+
## Release process (for maintainers)
69
69
70
70
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`.
0 commit comments