Skip to content

Commit 5715b2f

Browse files
committed
Add PR template, ESLint GH Action
1 parent b3920b5 commit 5715b2f

File tree

2 files changed

+66
-0
lines changed

2 files changed

+66
-0
lines changed

.github/pull_request_template.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
## Description
2+
3+
Please provide an explanation of the changes you've made:
4+
5+
<!-- Describe what this PR does and why -->
6+
7+
## Implementation Checklist
8+
9+
- [ ] Implemented this change in **TypeScript**
10+
- [ ] Implemented this change in **Python**
11+
12+
## Testing
13+
14+
- [ ] All tests pass locally
15+
- [ ] Linted
16+
- [ ] Added tests for new functionality (if applicable)
17+
18+
## Visual Proof
19+
20+
Please provide a screenshot or video demonstrating that your changes work locally:
21+
22+
<!-- Drag and drop your screenshot/video here or use the following format: -->
23+
<!-- ![Screenshot description](image-url) -->
24+
25+
## Related Issue
26+
27+
Fixes [Github issue link]
28+
29+
<!-- Replace with actual issue link, e.g., Fixes https://github.com/username/repo/issues/123 -->
30+
31+
## Additional Notes
32+
33+
<!-- Any additional context, concerns, or notes for reviewers -->

.github/workflows/eslint.yml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: ESLint
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
pull_request:
7+
branches: [ main ]
8+
9+
jobs:
10+
eslint:
11+
runs-on: ubuntu-latest
12+
13+
steps:
14+
- name: Checkout code
15+
uses: actions/checkout@v4
16+
17+
- name: Setup Bun
18+
uses: oven-sh/setup-bun@v1
19+
with:
20+
bun-version: latest
21+
22+
- name: Install dependencies
23+
run: bun install --frozen-lockfile
24+
25+
- name: Run ESLint
26+
run: bun run lint
27+
28+
- name: Annotate ESLint results
29+
uses: ataylorme/eslint-annotate-action@v2
30+
if: failure()
31+
with:
32+
repo-token: "${{ secrets.GITHUB_TOKEN }}"
33+
report-json: "eslint-report.json"

0 commit comments

Comments
 (0)