Skip to content

Commit e9462c6

Browse files
authored
Include /format worklfow in contributing.md and PR message (#132)
1 parent 36ba2bd commit e9462c6

3 files changed

Lines changed: 4 additions & 2 deletions

File tree

.github/workflows/contributor-reminder.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,5 +35,5 @@ jobs:
3535
issue_number: context.issue.number,
3636
owner: context.repo.owner,
3737
repo: context.repo.repo,
38-
body: "Thank you for submitting a pull request.\n\nPlease ensure your changes comply with the project's contribution guidelines and that all workflow checks pass successfully.\n\n### Formatting and Branching\n- Please confirm you have formatted your code using `npx prettier --write .`\n- Ensure this PR is made from a `feature/*` branch and not `main`.\n\n> **Note:** This project is currently maintained by a solo maintainer, so reviews and responses may sometimes take a little time. Thanks for your patience."
38+
body: "Thank you for submitting a pull request.\n\nPlease ensure your changes comply with the project's contribution guidelines and that all workflow checks pass successfully.\n\n### Formatting and Branching\n- Please confirm you have formatted your code locally using `npx prettier --write .`, or you can simply comment `/format` on this PR to have our bot do it for you!\n- Ensure this PR is made from a `feature/*` branch and not `main`.\n\n> **Note:** This project is currently maintained by a solo maintainer, so reviews and responses may sometimes take a little time. Thanks for your patience."
3939
})

.github/workflows/prettier-check.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,4 @@ jobs:
2525
node-version: "20"
2626

2727
- name: Run Prettier Requirements Check
28-
run: npx prettier --check "frontend/**/*.{html,css,js}" "scripts/**/*.js" "server.js"
28+
run: npx prettier --check .

CONTRIBUTING.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,8 @@ Before submitting your Pull Request, please run the following command in the roo
7575
npx prettier --write .
7676
```
7777

78+
Alternatively, you can comment `/format` on your Pull Request, and our GitHub Actions bot will automatically format your code and push the commit for you.
79+
7880
### Frontend Changes
7981

8082
Please keep the existing terminal-inspired design language of the platform in mind when making UI changes.

0 commit comments

Comments
 (0)