Skip to content

Commit

Permalink
Auto-format markdown; switch to double quotes for JS (#349)
Browse files Browse the repository at this point in the history
* Add markdown to pre-commit prettier

* Prettify markdown; use single quotes
  • Loading branch information
sarayourfriend authored Dec 13, 2022
1 parent 3c85d3a commit 1369d39
Show file tree
Hide file tree
Showing 26 changed files with 1,835 additions and 740 deletions.
14 changes: 7 additions & 7 deletions .github/GITHUB.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ to the "In progress" column.
### PR project automation

This workflow archives PRs in the "Merged!" and "Closed" columns of the PR
project board, 15 minutes after the commencement of the weekly developer chat
at 15:00 UTC every Tuesday.
project board, 15 minutes after the commencement of the weekly developer chat at
15:00 UTC every Tuesday.

**Cron:** [at 15:15 on Tuesday](https://crontab.guru/#15_15_*_*_2)

Expand All @@ -40,9 +40,9 @@ week, outlining the closed issues and merged PRs of the preceding week.

### New discussion notification

This workflow makes a `POST` request to the Slack webhook when a new
discussion is created, sending a notification message to the
`#openverse-notifications` channel.
This workflow makes a `POST` request to the Slack webhook when a new discussion
is created, sending a notification message to the `#openverse-notifications`
channel.

**Discussion:** created

Expand All @@ -54,7 +54,7 @@ truth, it creates PRs to resolve any differences.

**Cron:** [at 00:00](https://crontab.guru/#0_0_*_*_*)
**Push:** Branch `main`
**Dispatch:** enabled
**Dispatch:** enabled
**Config:** `.github/sync.yml`

## Synced workflows
Expand Down Expand Up @@ -101,5 +101,5 @@ These workflows run only in the downstream synced repos and not in `openverse`.
This workflow updates the draft release message when new commits are added to
`main` so that there is a ready-to-go changelog when publishing a new release.

**Push:** Branch `main`
**Push:** Branch `main`
**Config:** `.github/release_drafter.yml`
17 changes: 12 additions & 5 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,28 +6,35 @@ title: "<Replace this with actual title>"
---

## Description

<!-- Concisely describe the bug. Compare your experience with what you expected to happen. -->
<!-- For example: "I clicked the 'submit' button and instead of seeing a thank you message, I saw a blank page." -->

## Reproduction

<!-- Provide detailed steps to reproduce the bug. -->

1. <!-- Step 1 ... -->
2. <!-- Step 2 ... -->
3. <!-- Step 3 ... -->
4. See error.

## Screenshots

<!-- Add screenshots to show the problem; or delete the section entirely. -->

## Environment

<!-- Please complete this, unless you are certain the problem is not environment specific. -->
- Device: <!-- (_eg._ iPhone Xs; laptop) -->
- OS: <!-- (_eg._ iOS 13.5; Fedora 32) -->
- Browser: <!-- (_eg._ Safari; Firefox) -->
- Version: <!-- (_eg._ 13; 73) -->
- Other info: <!-- (_eg._ display resolution, ease-of-access settings) -->

- Device: <!-- (_eg._ iPhone Xs; laptop) -->
- OS: <!-- (_eg._ iOS 13.5; Fedora 32) -->
- Browser: <!-- (_eg._ Safari; Firefox) -->
- Version: <!-- (_eg._ 13; 73) -->
- Other info: <!-- (_eg._ display resolution, ease-of-access settings) -->

## Additional context

<!-- Add any other context about the problem here; or delete the section entirely. -->

<!-- If you would like to work on this, please comment below separately. -->
3 changes: 3 additions & 0 deletions .github/ISSUE_TEMPLATE/discussion.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,16 @@ title: "<Replace this with actual title>"
---

<!-- Consider how soon we need the discussion resolved vs. giving everyone an opportunity to participate. -->

## Due date: yyyy-mm-dd

<!-- Suggest two members of @WordPress/openverse to review the discussion. -->

## Assigned reviewers

- [ ] TBD
- [ ] TBD

<!-- Start the conversation. Please @ anyone relevant and try to ask questions to help facilate discussion. -->

## Description
4 changes: 4 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,19 @@ title: "<Replace this with actual title>"
---

## Problem

<!-- Describe a problem solved by this feature; or delete the section entirely. -->

## Description

<!-- Describe the feature and how it solves the problem. -->

## Alternatives

<!-- Describe any alternative solutions or features you have considered. How is this feature better? -->

## Additional context

<!-- Add any other context about the feature here; or delete the section entirely. -->

<!-- If you would like to work on this, please comment below separately. -->
19 changes: 15 additions & 4 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,39 @@
## Fixes

<!-- If PR doesn't fully resolve the issue, replace 'Fixes' below with 'Related to'. -->
<!-- If there is no issue being resolved, please consider opening one before creating this pull request. -->

Fixes #[issue number] by @[issue author]

## Description

<!-- Concisely describe what the pull request does. -->
<!-- Add screenshots, videos, or other media to show the problem and the solution when appropriate. -->

## Testing Instructions

<!-- Give steps for the reviewer to verify that this PR fixes the problem; or delete this section entirely. -->

## Checklist

<!-- Replace the [ ] with [x] to check the boxes. -->
- [ ] My pull request has a descriptive title (not a vague title like `Update index.md`).
- [ ] My pull request targets the *default* branch of the repository (`main`) or a parent feature branch.

- [ ] My pull request has a descriptive title (not a vague title like
`Update index.md`).
- [ ] My pull request targets the _default_ branch of the repository (`main`) or
a parent feature branch.
- [ ] My commit messages follow [best practices][best_practices].
- [ ] My code follows the established code style of the repository.
- [ ] I added or updated tests for the changes I made (if applicable).
- [ ] I added or updated documentation (if applicable).
- [ ] I tried running the project locally and verified that there are no visible errors.
- [ ] I tried running the project locally and verified that there are no visible
errors.

[best_practices]:https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#_commit_guidelines
[best_practices]:
https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#_commit_guidelines

## Developer Certificate of Origin

<!-- You must read and understand the following attestation. -->

<details>
Expand Down
3 changes: 1 addition & 2 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ repos:
hooks:
- id: eslint
files: ^js/.*$
'types': [file] # ESLint only accepts [javascript] by default.
"types": [file] # ESLint only accepts [javascript] by default.
args:
- --ignore-path=.gitignore
- --ignore-path=.eslintignore
Expand All @@ -82,7 +82,6 @@ repos:
rev: v2.6.0
hooks:
- id: prettier
exclude: \.md$ # TODO: https://github.com/WordPress/openverse/issues/333
additional_dependencies:
- [email protected]

Expand Down
5 changes: 2 additions & 3 deletions .pre-commit-config.yaml.jinja
Original file line number Diff line number Diff line change
Expand Up @@ -76,11 +76,11 @@ repos:
rev: v8.15.0
hooks:
- id: eslint
files: {{ eslint_files | default('^js/.*$') }}
files: {{ eslint_files | default("^js/.*$") }}
{% if eslint_exclude %}
exclude: {{ eslint_exclude }} # ESLint raises warnings for ignored files.
{% endif %}
'types': [file] # ESLint only accepts [javascript] by default.
"types": [file] # ESLint only accepts [javascript] by default.
args:
- --ignore-path=.gitignore
- --ignore-path=.eslintignore
Expand All @@ -98,7 +98,6 @@ repos:
rev: v2.6.0
hooks:
- id: prettier
exclude: \.md$ # TODO: https://github.com/WordPress/openverse/issues/333
additional_dependencies:
{% block prettier_dependencies %}
- [email protected]
Expand Down
Loading

0 comments on commit 1369d39

Please sign in to comment.