Skip to content

Commit 511c5e4

Browse files
authored
improve contributor workflow guidance and repo formatting rules (#129)
* improve contributor workflow guidance and repo formatting rules * exempt maintainer from auto reminders
1 parent 0d601d5 commit 511c5e4

3 files changed

Lines changed: 16 additions & 8 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,8 @@ Fixes # (issue number)
3131
## Checklist
3232

3333
- [ ] My code follows the project's coding style
34-
- [ ] I have formatted my code locally using Prettier
34+
- [ ] I have formatted my code locally by running `npx prettier --write .` before submitting
35+
- [ ] I am submitting my PR from a dedicated `feature/*` branch, not the `main` branch
3536
- [ ] I have performed a self-review of my code
3637
- [ ] My changes generate no new warnings or errors
3738
- [ ] I have updated documentation if required

.github/workflows/contributor-reminder.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,25 +15,25 @@ jobs:
1515

1616
steps:
1717
- name: Comment on Issue
18-
if: github.event_name == 'issues'
18+
if: github.event_name == 'issues' && github.actor != 'jagdish-15'
1919
uses: actions/github-script@v7
2020
with:
2121
script: |
2222
github.rest.issues.createComment({
2323
issue_number: context.issue.number,
2424
owner: context.repo.owner,
2525
repo: context.repo.repo,
26-
body: "Thank you for opening an issue.\n\nPlease review our `CONTRIBUTING.md` guidelines before getting started.\n\nA maintainer will review this issue shortly. If you would like to work on the issue yourself, please leave a comment requesting assignment."
26+
body: "Thank you for opening an issue.\n\nPlease review our `CONTRIBUTING.md` guidelines before getting started.\n\nA maintainer will review this issue shortly. If you would like to work on the issue yourself, please leave a comment requesting assignment.\n\n### Issue Assignment Policy\n- The issue creator is given the first priority to work on their issue.\n- If the creator declines or does not request assignment, the issue will be assigned to others in the order of requests received.\n- Please do not submit PRs or begin work until you are officially assigned.\n\n> **Note:** This project is currently maintained by a solo maintainer, so reviews, assignments, and responses may sometimes take a little time. Thanks for your patience."
2727
})
2828
2929
- name: Comment on Pull Request
30-
if: github.event_name == 'pull_request_target'
30+
if: github.event_name == 'pull_request_target' && github.actor != 'jagdish-15'
3131
uses: actions/github-script@v7
3232
with:
3333
script: |
3434
github.rest.issues.createComment({
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\nA maintainer will review your submission shortly."
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."
3939
})

CONTRIBUTING.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,15 @@ npm start
4141
## Before You Start
4242

4343
- Check whether an issue already exists for the change you want to make.
44-
- If you would like to work on an existing issue, please request assignment before starting work.
45-
- Please do not submit PRs for issues assigned to another contributor unless approved by a maintainer.
44+
- If you would like to work on an existing issue, please request assignment.
45+
- **Please do not start working on an issue or submit PRs until you are officially assigned.**
46+
47+
### Issue Assignment Policy
48+
49+
- The issue creator is given the first priority to work on their issue.
50+
- If the creator declines or does not request assignment, the issue will be assigned to others in the order of requests received (first-come, first-served).
51+
52+
> **Note:** This project is currently maintained by a solo maintainer, so reviews, assignments, and responses may sometimes take a little time. Thanks for your patience.
4653
4754
## Pull Requests
4855

@@ -65,7 +72,7 @@ We use Prettier to enforce consistent code style across the project. Our automat
6572
Before submitting your Pull Request, please run the following command in the root of the repository to automatically format all your changes:
6673

6774
```bash
68-
npx prettier --write "frontend/**/*.{html,css,js}" "scripts/**/*.js" "server.js"
75+
npx prettier --write .
6976
```
7077

7178
### Frontend Changes

0 commit comments

Comments
 (0)