Ma77Ball opened a new issue, #5621:
URL: https://github.com/apache/texera/issues/5621

   ### Task Summary
   
   Add a lightweight, **non-blocking** GitHub Actions workflow that posts a 
friendly comment when a pull request (or issue) is opened/edited without 
following our template, and automatically removes that comment once the 
description is fixed.
   
   This is the gentle, no-enforcement version of #4227. That issue and its 
implementation PR #4228 aimed to *enforce* template compliance (failing checks 
/ required related-issue references). #4228 was closed after a -1: strictly 
enforcing the template would require a formal Apache vote, and the preference 
was to keep templates a flexible "nice-to-have."
   
   A **warning-only** approach sidesteps that objection entirely: it enforces 
nothing and blocks no merges, so it does not change project policy or require a 
vote. It simply nudges contributors toward the existing template and improves 
traceability (the main pain point raised in #4227: PRs that omit the "Any 
related issues, documentation, discussions?" linkage).
   
   **Proposed behavior**
   - On a PR/issue **opened** or **edited**: read the description, strip the 
template's `<!-- ... -->` guidance, and if the description is empty or (for 
PRs) a required section is missing/blank, post a single comment listing exactly 
what is incomplete. When the author fixes it, the comment is deleted 
automatically.
   - Skips drafts and bots.
   - For issues: our issue templates are GitHub **form** (`.yaml`) templates 
whose `required` fields are already enforced at submission, so this only 
catches a fully blank body. PR templates cannot be enforced by GitHub, which is 
the primary case this covers.
   
   **Why keep it non-blocking**
   - No merge is ever blocked and no status check fails, so it is purely 
advisory and does not require an Apache vote (the blocker for #4228).
   - Contributors keep full flexibility; trivial PRs (the 2-character-fix 
concern raised on #4227) are nudged but never stopped.
   
   **Designed to be cheap on CI**
   - A single `github-script` job: no build, and instead of a full checkout it 
sparse-checks-out only the one message file, so a run is a few seconds on 
`ubuntu-latest`.
   - Triggers only on `opened` / `edited`, never `synchronize`, so it does not 
re-run on every push to a PR branch.
   - Posts a single self-resolving "sticky" comment (idempotency marker) that 
is updated in place while incomplete and deleted once resolved, so comments 
never pile up.
   
   **Related**
   - Follow-up / non-blocking alternative to #4227 (closed as completed)
   - Supersedes the enforcement approach in #4228 (closed, not merged)
   
   ### Task Type
   
   - [ ] Refactor / Cleanup
   - [X] DevOps / Deployment / CI
   - [ ] Testing / QA
   - [ ] Documentation
   - [ ] Performance
   - [ ] Other
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to