Skip to content

Commit 01e2810

Browse files
willingclwasser
authored andcommitted
Fix trailing whitespace
1 parent 8d3e9a3 commit 01e2810

File tree

1 file changed

+18
-9
lines changed

1 file changed

+18
-9
lines changed

CONTRIBUTING.md

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,13 @@ files in the following repos:
2121

2222
Running this script:
2323

24-
1. Parses through all of the all-contributors bot `.json` files across our pyOpenSci repos to gather contributors to our organization. This allows us to [acknowledge contributors on our website](https://www.pyopensci.org/our-community/#pyopensci-community-contributors) who are not always making explicit code contributions (thus might not have commits). These contributors are reviewing guidebooks, participating in peer review, and performing other important tasks that are critical to our pyOpenSci mission. We acknowledge all contributions at pyOpenSci regardless of volume or size.
25-
2. Updates the existing [contributors.yml](https://github.com/pyOpenSci/pyopensci.github.io/blob/main/_data/contributors.yml) file found in our website repo with new contributors and the contributor role (package guides, code workflows, peer review, etc).
24+
1. Parses through all of the all-contributors bot `.json` files across our pyOpenSci repos to gather contributors to
25+
our organization. This allows us to [acknowledge contributors on our website](https://www.pyopensci.org/our-community/#pyopensci-community-contributors)
26+
who are not always making explicit code contributions (thus might not have commits). These contributors are
27+
reviewing guidebooks, participating in peer review, and performing other important tasks that are critical to our
28+
pyOpenSci mission. We acknowledge all contributions at pyOpenSci regardless of volume or size.
29+
2. Updates the existing [contributors.yml](https://github.com/pyOpenSci/pyopensci.github.io/blob/main/_data/contributors.yml)
30+
file found in our website repo with new contributors and the contributor role (package guides, code workflows, peer review, etc).
2631
If you run the script using `--update update_all`, this script will also use the GitHub api to update the users metadata from their GitHub profile.
2732

2833
## update-reviews script
@@ -31,7 +36,8 @@ To run this script, you can call the following at the command line:
3136

3237
`update-reviews`
3338

34-
This script parses through our (_accepted_) review issues to find packages that have been accepted. It then grabs each reviews editor, reviewers and package authors / maintainers. This information allows us to
39+
This script parses through our (_accepted_) review issues to find packages that have been accepted. It then grabs each
40+
reviews editor, reviewers and package authors / maintainers. This information allows us to
3541

3642
1. Update a contributor's peer review metadata in the contributors.yml file in the third script.
3743
2. Update the pyOpenSci website's package listing with the package's DOI, documentation URL.
@@ -55,8 +61,8 @@ first two scripts to update each contributors peer review contributions includin
5561
- package-reviewer
5662
- package-editor
5763

58-
These general contributor types are used to drive our [website's
59-
contributor search and filter functionality that you can see here.](https://www.pyopensci.org/our-community/index.html#pyopensci-community-contributors)
64+
These general contributor types are used to drive our
65+
[website's contributor search and filter functionality that you can see here.](https://www.pyopensci.org/our-community/index.html#pyopensci-community-contributors)
6066

6167
## Local setup
6268

@@ -65,7 +71,7 @@ contributor search and filter functionality that you can see here.](https://www.
6571
```bash
6672
mamba create -n pyos-meta python=3.10
6773
mamba activate pyos-meta
68-
```
74+
```
6975

7076
2. Install the package in editable mode and associated development dependencies:
7177

@@ -96,7 +102,8 @@ To run:
96102

97103
The `update-contributors` script does the following:
98104

99-
1. It grabs the `all-contribs.json` files from each repository and turns that json data into a dictionary of all unique contributors across repos. Repos include:
105+
1. It grabs the `all-contribs.json` files from each repository and turns that json data into a dictionary of all unique
106+
contributors across repos. Repos include:
100107
- peer review guide
101108
- packaging guide
102109
- website
@@ -147,8 +154,10 @@ This returns a `packages.pickle` file that will be used in the final script whic
147154
This script is a bridge between `update-contributors` and `update-reviews`. It parses each review in the output
148155
`update-reviews.pickle` file and
149156

150-
1. updates contributor name in the review data (often the github username is there but the first and last name is missing). This allows us to publish the maintainer names (rather than github usernames) [on our website package listing.](https://www.pyopensci.org/python-packages.html#explore-our-accepted-scientific-python-open-source-packages)
151-
2. Updates each review issue contributor's name in the contributor metadata. This allows us to ensure we have updated contributor types, package submission information etc, in the contributor.yml file on our website.
157+
1. updates contributor name in the review data (often the github username is there but the first and last name is missing).
158+
This allows us to publish the maintainer names (rather than github usernames) [on our website package listing.](https://www.pyopensci.org/python-packages.html#explore-our-accepted-scientific-python-open-source-packages)
159+
2. Updates each review issue contributor's name in the contributor metadata. This allows us to ensure we have updated
160+
contributor types, package submission information etc, in the contributor.yml file on our website.
152161

153162
To run:
154163
`update_reviewers`

0 commit comments

Comments
 (0)