Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Pr template.md #47

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions .github/pr_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
## Description

Please include a summary of the change and which issue is fixed. Also include relevant motivation and context.

- Fixes #(issue number)

## Type of change

Please delete options that are not relevant.

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] Documentation update
- [ ] Tests update

## Checklist

- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] My changes generate no new warnings
- [ ] New and existing unit tests pass locally with my changes
- [ ] I have maintained a clean commit history by using the necessary Git commands
- [ ] I have checked that my code does not cause any merge conflicts

## Screenshots (if applicable)

Add screenshots to help explain the changes (if necessary).
27 changes: 27 additions & 0 deletions .github/workflows/check_screenshot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: Check Screenshot in PR

on:
pull_request:
types: [opened, edited, synchronize]

jobs:
check-screenshot:
runs-on: ubuntu-latest

steps:
- name: Check if screenshot is attached
id: check_screenshot
run: |
# Fetch the PR body (description) using jq
PR_BODY=$(jq -r '.pull_request.body' "$GITHUB_EVENT_PATH")

# Log the PR body for debugging (you can remove this later)
echo "PR BODY: $PR_BODY"

# Check if the PR body contains a GitHub-hosted image URL or image extensions (png, jpg, jpeg, gif)
if echo "$PR_BODY" | grep -E "https://github.com/.+/assets/|\.png|\.jpg|\.jpeg|\.gif"; then
echo "Screenshot found!"
else
echo "No screenshot found! Please attach a screenshot to your PR."
exit 1 # Fail the workflow if no screenshot is found
fi