asf-tooling commented on issue #1190:
URL:
https://github.com/apache/tooling-trusted-releases/issues/1190#issuecomment-4409725603
<!-- gofannon-issue-triage-bot v2 -->
**Automated triage** — analyzed at `main@2da7807a`
**Type:** `new_feature` • **Classification:** `actionable` •
**Confidence:** `low`
**Application domain(s):** `web_api_infrastructure`, `automated_checks`,
`shared_infrastructure`
### Summary
Issue #1190 requests two enhancements: (1) adding a general feedback request
to the existing alpha banner, and (2) adding context-specific feedback forms
triggered by certain conditions (e.g., lightweight license check failures
asking about project-specific ignore patterns). The source files provided are
all configuration/CI files, so I cannot cite the actual template code for the
alpha banner or the lightweight license check implementation. Based on the
architecture, the relevant code lives in template files (for the banner),
`atr/tasks/checks/license.py` (for check results), and potentially `atr/get/`
routes (for rendering feedback forms).
### Where new code would go
- `atr/templates/` — base template (likely base.html or layout.html)
The alpha banner almost certainly lives in a base/layout template that
wraps all pages. The general feedback link would be added here.
- `atr/get/compose.py or atr/get/vote.py` — route handlers that render check
results
Context-specific feedback forms (e.g., for lightweight license check
failures) would be rendered on pages that display check results to the user.
- `atr/tasks/checks/license.py` — lightweight license check logic
The issue specifically mentions lightweight license checks failing and
wanting to collect user feedback about ignore locations. The check results may
need metadata to indicate a feedback form should be shown.
- `atr/shared/` — shared template partials or components
Feedback form components could be shared partials reused across different
check result displays.
### Proposed approach
This feature has two parts. First, the alpha banner (presumably a site-wide
notification bar in the base template) should be enhanced to include a general
feedback request with a link to a feedback channel (GitHub issues, a form, or
an email address). This is likely a simple template text change.
Second, context-specific feedback forms should be added to pages that
display check results. For the lightweight license check case, when a check
fails, the UI should present a form asking users about specific ignore
locations their project uses. This would require: (1) identifying the
template/page where check results are displayed, (2) adding conditional
rendering of a feedback form when certain checks fail, and (3) either creating
a POST endpoint to handle feedback submissions or linking to an external form
(GitHub issue template with pre-filled fields). Without access to the actual
template and route source code, I cannot propose specific diffs.
### Open questions
- What template file contains the alpha banner? (likely a base/layout
template - not provided in source files)
- Where are check results displayed to users? (likely in compose or vote GET
routes)
- Should feedback be collected via an internal form (requiring a new POST
endpoint and possibly database storage) or via external links (GitHub issue
templates, Google Forms)?
- What specific data should the lightweight license check feedback form
collect (ignore paths, file patterns, rationale)?
- Is there already a mechanism for contextual alerts/notifications on check
result pages that could be extended?
### Files examined
- `.asf.yaml`
- `.github/PULL_REQUEST_TEMPLATE.md`
- `.github/dependabot.yml`
- `.github/labeler.yml`
- `.github/linters/.markdown-lint.yml`
- `.github/workflows/allowlistchecker.yml`
- `.github/workflows/analyze.yml`
- `.github/workflows/build.yml`
---
*Draft from a triage agent. A human reviewer should validate before merging
any change. The agent did not run tests or verify diffs apply.*
--
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]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
