Skip to content

Commit 8e8b2d9

Browse files
committed
chore: improve PR template
Signed-off-by: Tomas Weiss <tomas.weiss2@gmail.com>
1 parent b42bb13 commit 8e8b2d9

File tree

2 files changed

+6
-7
lines changed

2 files changed

+6
-7
lines changed

.github/pull_request_template.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
11
## Summary
22
<!-- Briefly describe what this PR changes -->
33

4+
## Linked Issues
5+
<!-- Make sure the linked issue is always provided eg: -->
6+
<!-- Closes #XYZ, Fixes #XYZ, Resolves #XYZ -->
7+
8+
49
## Documentation
5-
- [ ] Docs updated
610
- [ ] No Docs Needed:
711

8-
If this PR adds new APIs, features, or changes existing behavior, you must update `/docs` accordingly.
12+
If this PR adds new feature or changes existing. Make sure documentation is adjusted accordingly. If the docs is not needed, please explain why.

.github/workflows/docs-check.yaml

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@ name: Docs Check
22

33
on:
44
pull_request:
5-
# types: [ready_for_review]
65
types: [opened, synchronize, reopened, edited]
76

87
jobs:
@@ -15,7 +14,6 @@ jobs:
1514
steps:
1615
- uses: actions/checkout@v4
1716

18-
# 1️⃣ Get PR body
1917
- name: Get PR body
2018
id: get_pr
2119
uses: actions/github-script@v7
@@ -26,7 +24,6 @@ jobs:
2624
fs.writeFileSync('pr_body.txt', body, 'utf8');
2725
core.setOutput("body", body);
2826
29-
# 2️⃣ Check if "No Docs Needed" is checked
3027
- name: Check for No Docs Needed checkbox
3128
id: skip
3229
run: |
@@ -37,7 +34,6 @@ jobs:
3734
echo "skip=false" >> $GITHUB_OUTPUT
3835
fi
3936
40-
# 3️⃣ Get changed files
4137
- name: Get changed files
4238
run: |
4339
git fetch origin ${{ github.event.pull_request.base.ref }}
@@ -49,7 +45,6 @@ jobs:
4945
fi
5046
cat changed_files.txt
5147
52-
# 4️⃣ Enforce docs update unless skipped
5348
- name: Enforce docs update
5449
run: |
5550
if [ "${{ steps.skip.outputs.skip }}" = "true" ]; then

0 commit comments

Comments
 (0)