Skip to content

Commit b6752f4

Browse files
authored
add: contributing info for updating dates, style upgrades & new blockquote styles
2 parents c56cdef + 597a233 commit b6752f4

20 files changed

+621
-117
lines changed

.pre-commit-config.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,3 +40,9 @@ repos:
4040
- yaml
4141
additional_dependencies:
4242
- tomli
43+
44+
# - repo: https://github.com/pre-commit/mirrors-prettier
45+
# rev: v3.1.0
46+
# hooks:
47+
# - id: prettier
48+
# types_or: [yaml]

.prettierignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
**/page__date.html

CONTRIBUTING.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,32 @@
55
If you are interested in contributing to pyOpenSci, please read about
66
how we work in [**pyOpenSci's organization-wide contributing guide**](https://www.pyopensci.org/handbook/CONTRIBUTING.html).
77

8-
## Repositories
8+
## Updating blog posts
9+
10+
Recently we added a bash script called: `scripts/date-updated.sh`. This script
11+
will run through all posts in the `_posts/` directory and add the date that it was
12+
last updated using your local git commit history. It will only update the date_update
13+
yaml key if the `last_updated:` yaml key exists in the page's front matter.
14+
15+
Right now
16+
it is a manual process to add `last_updated:` to all of our posts as a key.
17+
18+
You have to run the bash script at the command line, in the root of
19+
this repository.
20+
21+
You may have to update the permissions
22+
to allow it to modify files like this:
23+
24+
25+
`chmod +x scripts/date-updated.sh`
26+
27+
then you can run the script:
28+
29+
`./scripts/date-updated.sh`
30+
31+
In the future we will add this step to our CI build.
32+
33+
## Contributing to other pyOpenSci GitHub Repositories
934

1035
If you are interested in contributing to a specific repository, please review
1136
the `README.md` and `CONTRIBUTING.md` files in the repository. If you have any

_includes/page__date.html

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,24 @@
1+
<!-- prettier-ignore-file -->
2+
13
{% assign date_format = site.date_format | default: "%B %-d, %Y" %}
2-
{% if page.last_modified_at %}
3-
<p class="page__date"><strong><i class="fas fa-fw fa-calendar-alt" aria-hidden="true"></i> {{ site.data.ui-text[site.locale].date_label | default: "Updated:" }}</strong> <time class="dt-published" datetime="{{ page.last_modified_at | date: "%Y-%m-%d" }}">{{ page.last_modified_at | date: date_format }}</time></p>
4+
{% if page.last_modified %}
5+
<p class="page__date">
6+
<strong>
7+
<i class="fas fa-fw fa-calendar-alt" aria-hidden="true"></i>
8+
{{ site.data.ui-text[site.locale].date_label | default: "Updated:" }}
9+
</strong>
10+
<time class="dt-published" datetime="{{ page.last_modified | date: '%Y-%m-%d' }}">
11+
{{ page.last_modified | date: date_format }}
12+
</time>
13+
</p>
414
{% elsif page.date %}
5-
<p class="page__date"><strong><i class="fas fa-fw fa-calendar-alt" aria-hidden="true"></i> {{ site.data.ui-text[site.locale].date_label | default: "Updated:" }}</strong> <time class="dt-published" datetime="{{ page.date | date_to_xmlschema }}">{{ page.date | date: date_format }}</time></p>
15+
<p class="page__date">
16+
<strong>
17+
<i class="fas fa-fw fa-calendar-alt" aria-hidden="true"></i>
18+
{{ site.data.ui-text[site.locale].date_label | default: "Updated:" }}
19+
</strong>
20+
<time class="dt-published" datetime="{{ page.date | date_to_xmlschema }}">
21+
{{ page.date | date: date_format }}
22+
</time>
23+
</p>
624
{% endif %}

_includes/pyos-blockquote.html

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<blockquote
2+
class="highlight-quote {% if include.class %}{{ include.class }}{% endif %}"
3+
>
4+
<p class="quote">{{ include.quote }}</p>
5+
<footer>
6+
{% if include.author %}<strong>~{{ include.author }}{% endif %}</strong>{%
7+
if include.event %}, <em>{{ include.event }}</em>{% endif %}
8+
</footer>
9+
</blockquote>

_pages/about-peer-review.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -125,10 +125,12 @@ editor role at pyOpenSci [in our peer review guide.](https://www.pyopensci.org/s
125125
{% assign editors = site.data.contributors | where: 'editorial_board', true %}
126126
{% assign editors = editors | sort: 'sort' %}
127127

128-
<div class="grid clean">
128+
<div class="grid">
129129
{% for aperson in editors %}
130130
{% include people-grid.html %}
131131
{% endfor %}
132+
133+
132134
</div>
133135

134136
<br clear="both">
@@ -139,7 +141,7 @@ We are deeply grateful for those served on our editorial board previously!
139141

140142
{% assign emeritus = site.data.contributors | where: 'emeritus_editor', true %}
141143

142-
<div class="grid clean">
144+
<div class="grid">
143145
{% for aperson in emeritus %}
144146
{% include people-grid.html %}
145147
{% endfor %}

_pages/home.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -57,11 +57,13 @@ peer-review:
5757
<div class="archive__item-body">
5858
<h2 class="archive__item-title">Peer review mentorship program</h2>
5959
<div class="archive__item-excerpt">
60-
<p>We are building diverse community around the scientific packages that drive open science. We recruit and support editors and reviewers from different backgrounds and gender-identities in each review that we perform.
61-
</p>
62-
Are you new to peer review? We got you!
60+
<p>
61+
We are building diverse community around the scientific packages that drive open science. We recruit and support editors and reviewers from different backgrounds and gender-identities in each review that we perform.
62+
</p>
63+
<p>
64+
Are you new to peer review?
6365
We offer a <a href="https://www.pyopensci.org/software-peer-review/how-to/reviewer-guide.html#a-guide-for-new-reviewers">mentorship program </a> for anyone interested in participating in peer review but who might like a bit of support.
64-
66+
</p>
6567
</div>
6668
</div>
6769
</div>
@@ -71,7 +73,7 @@ peer-review:
7173

7274
{% assign new_ppl = site.data.contributors | reverse %}
7375

74-
## Latest contributors
76+
## New pyOpenSci contributors
7577

7678
<div class="entries-grid">
7779
{% for aperson in new_ppl limit:4 %}

0 commit comments

Comments
 (0)