Skip to content

Commit

Permalink
add: contributing info for updating dates, style upgrades & new block…
Browse files Browse the repository at this point in the history
…quote styles
  • Loading branch information
lwasser authored Aug 29, 2024
2 parents c56cdef + 597a233 commit b6752f4
Show file tree
Hide file tree
Showing 20 changed files with 621 additions and 117 deletions.
6 changes: 6 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,9 @@ repos:
- yaml
additional_dependencies:
- tomli

# - repo: https://github.com/pre-commit/mirrors-prettier
# rev: v3.1.0
# hooks:
# - id: prettier
# types_or: [yaml]
1 change: 1 addition & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
**/page__date.html
27 changes: 26 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,32 @@
If you are interested in contributing to pyOpenSci, please read about
how we work in [**pyOpenSci's organization-wide contributing guide**](https://www.pyopensci.org/handbook/CONTRIBUTING.html).

## Repositories
## Updating blog posts

Recently we added a bash script called: `scripts/date-updated.sh`. This script
will run through all posts in the `_posts/` directory and add the date that it was
last updated using your local git commit history. It will only update the date_update
yaml key if the `last_updated:` yaml key exists in the page's front matter.

Right now
it is a manual process to add `last_updated:` to all of our posts as a key.

You have to run the bash script at the command line, in the root of
this repository.

You may have to update the permissions
to allow it to modify files like this:


`chmod +x scripts/date-updated.sh`

then you can run the script:

`./scripts/date-updated.sh`

In the future we will add this step to our CI build.

## Contributing to other pyOpenSci GitHub Repositories

If you are interested in contributing to a specific repository, please review
the `README.md` and `CONTRIBUTING.md` files in the repository. If you have any
Expand Down
24 changes: 21 additions & 3 deletions _includes/page__date.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,24 @@
<!-- prettier-ignore-file -->

{% assign date_format = site.date_format | default: "%B %-d, %Y" %}
{% if page.last_modified_at %}
<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>
{% if page.last_modified %}
<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 | date: '%Y-%m-%d' }}">
{{ page.last_modified | date: date_format }}
</time>
</p>
{% elsif page.date %}
<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>
<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>
{% endif %}
9 changes: 9 additions & 0 deletions _includes/pyos-blockquote.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<blockquote
class="highlight-quote {% if include.class %}{{ include.class }}{% endif %}"
>
<p class="quote">{{ include.quote }}</p>
<footer>
{% if include.author %}<strong>~{{ include.author }}{% endif %}</strong>{%
if include.event %}, <em>{{ include.event }}</em>{% endif %}
</footer>
</blockquote>
6 changes: 4 additions & 2 deletions _pages/about-peer-review.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,10 +125,12 @@ editor role at pyOpenSci [in our peer review guide.](https://www.pyopensci.org/s
{% assign editors = site.data.contributors | where: 'editorial_board', true %}
{% assign editors = editors | sort: 'sort' %}

<div class="grid clean">
<div class="grid">
{% for aperson in editors %}
{% include people-grid.html %}
{% endfor %}


</div>

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

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

<div class="grid clean">
<div class="grid">
{% for aperson in emeritus %}
{% include people-grid.html %}
{% endfor %}
Expand Down
12 changes: 7 additions & 5 deletions _pages/home.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,11 +57,13 @@ peer-review:
<div class="archive__item-body">
<h2 class="archive__item-title">Peer review mentorship program</h2>
<div class="archive__item-excerpt">
<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.
</p>
Are you new to peer review? We got you!
<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.
</p>
<p>
Are you new to peer review?
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.

</p>
</div>
</div>
</div>
Expand All @@ -71,7 +73,7 @@ peer-review:

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

## Latest contributors
## New pyOpenSci contributors

<div class="entries-grid">
{% for aperson in new_ppl limit:4 %}
Expand Down
Loading

0 comments on commit b6752f4

Please sign in to comment.