Skip to content

Commit

Permalink
Add linter for markdown (#1226)
Browse files Browse the repository at this point in the history
This uses `prettier` to check markdown files are formatted in a
consistent way. This was inspired by a recent PR I made on `uv` where
https://github.com/astral-sh/uv/blob/98523e2014e9a5c69706623344026d76296e178f/.github/workflows/ci.yml#L67C1-L70C61
caught some typos / weird white spaces the editor left.

`npx prettier --prose-wrap always --check "**/*.md" --write` can be used
to reformat
  • Loading branch information
cthoyt authored Oct 24, 2024
1 parent 69c1dff commit e1a793d
Show file tree
Hide file tree
Showing 33 changed files with 611 additions and 499 deletions.
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/add-new-collection.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@ name: Add new collection
about: Add a collection of resources
title: Add new collection
labels: New
assignees: ''

assignees: ""
---

## Title
Expand All @@ -25,4 +24,5 @@ assignees: ''
## Author ORCID Identifier

> Replace this with the ORCID identifier of the author, or list of ORCID identifiers separated by commas corresponding to the author list
> Replace this with the ORCID identifier of the author, or list of ORCID
> identifiers separated by commas corresponding to the author list
5 changes: 5 additions & 0 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,11 @@ jobs:
run: |
uvx -p ${{ matrix.python-version }} --with tox-uv tox -e ${{ matrix.tox-command }}
# Inspired by https://github.com/astral-sh/uv/blob/98523e2014e9a5c69706623344026d76296e178f/.github/workflows/ci.yml#L67C1-L70C61
- name: "Prettier"
run: |
npx prettier --prose-wrap always --check "**/*.md"
docs:
name: Documentation
runs-on: ubuntu-latest
Expand Down
146 changes: 88 additions & 58 deletions README.md

Large diffs are not rendered by default.

63 changes: 32 additions & 31 deletions docs/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,15 @@ layout: page
title: Code of Conduct
permalink: /conduct/
---

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual identity
and orientation.
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.
Expand All @@ -20,26 +21,26 @@ diverse, inclusive, and healthy community.
Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
overall community
- Focusing on what is best not just for us as individuals, but for the overall
community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission. As a slight departure from the
verbatim text from the Contributor Covenant, we relax this restriction when
related to the publicly available contact information for individuals related
to the data in the Bioregistry (i.e., contributors, reviewers, contact people).
* Other conduct which could reasonably be considered inappropriate in a
- The use of sexualized language or imagery, and sexual attention or advances of
any kind
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email address,
without their explicit permission. As a slight departure from the verbatim
text from the Contributor Covenant, we relax this restriction when related to
the publicly available contact information for individuals related to the data
in the Bioregistry (i.e., contributors, reviewers, contact people).
- Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities
Expand All @@ -66,8 +67,8 @@ representative at an online or offline event.

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
{{ site.email }}.
All complaints will be reviewed and investigated promptly and fairly.
{{ site.email }}. All complaints will be reviewed and investigated promptly and
fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.
Expand All @@ -88,15 +89,15 @@ behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series
of actions.
**Community Impact**: A violation through a single incident or series of
actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.
like social media. Violating these terms may lead to a temporary or permanent
ban.

### 3. Temporary Ban

Expand All @@ -112,24 +113,24 @@ Violating these terms may lead to a permanent ban.
### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within
the community.
**Consequence**: A permanent ban from any sort of public interaction within the
community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.1, available at
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].

Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder][Mozilla CoC].

For answers to common questions about this code of conduct, see the FAQ at
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
at [https://www.contributor-covenant.org/translations][translations].
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
[https://www.contributor-covenant.org/translations][translations].

[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
Expand Down
Loading

0 comments on commit e1a793d

Please sign in to comment.