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
+18-9Lines changed: 18 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,8 +21,13 @@ files in the following repos:
21
21
22
22
Running this script:
23
23
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).
26
31
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.
27
32
28
33
## update-reviews script
@@ -31,7 +36,8 @@ To run this script, you can call the following at the command line:
31
36
32
37
`update-reviews`
33
38
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
35
41
36
42
1. Update a contributor's peer review metadata in the contributors.yml file in the third script.
37
43
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
55
61
- package-reviewer
56
62
- package-editor
57
63
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)
60
66
61
67
## Local setup
62
68
@@ -65,7 +71,7 @@ contributor search and filter functionality that you can see here.](https://www.
65
71
```bash
66
72
mamba create -n pyos-meta python=3.10
67
73
mamba activate pyos-meta
68
-
```
74
+
```
69
75
70
76
2. Install the package in editable mode and associated development dependencies:
71
77
@@ -96,7 +102,8 @@ To run:
96
102
97
103
The `update-contributors` script does the following:
98
104
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:
100
107
- peer review guide
101
108
- packaging guide
102
109
- website
@@ -147,8 +154,10 @@ This returns a `packages.pickle` file that will be used in the final script whic
147
154
This script is a bridge between `update-contributors` and `update-reviews`. It parses each review in the output
148
155
`update-reviews.pickle` file and
149
156
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.
0 commit comments