Aman-Mittal opened a new issue, #236:
URL: https://github.com/apache/fineract-backoffice-ui/issues/236

   ## What is wrong
   
   `.github/` has issue templates (`bug_report.yml`, `feature_request.yml`, 
`config.yml`) but no pull request template. Every PR starts from an empty box.
   
   ## Business value
   
   The repository has a fair number of conventions that are not guessable from 
the diff, and a reviewer currently checks each one by hand on every PR:
   
   - the API client under `src/app/api` is generated and must not be hand-edited
   - new components go through the adapter boundary (ADR-0003) rather than 
importing browser globals
   - user-facing strings need a translation key, and `npm run i18n:check` 
enforces it
   - a screen change wants a unit test and an e2e test, and the e2e suite is 
split into a mocked project and a real-backend project with different rules
   
   A template turns those from things a reviewer remembers into things an 
author confirms. That saves a round trip on most PRs, and the round trip is the 
expensive part: a contributor in a different timezone loses a day to a review 
comment that a checklist would have caught before pushing.
   
   For a first-time contributor it does more than that — it is often the 
clearest statement of what "done" means here.
   
   ## How to fix
   
   Add `.github/pull_request_template.md`. Keep it short; a long template gets 
skimmed and ticked without reading.
   
   Worth including:
   
   - **What and why** — one or two sentences, plus the issue it closes.
   - **How it was verified** — which commands were run, and whether it was 
exercised against a real backend or only mocks. This one carries real weight: 
several defects in this repository were invisible to unit tests and the mocked 
e2e suite, and only appeared when the UI was driven against a live Fineract.
   - **A short checklist** of the conventions above.
   - **Screenshots for UI changes.**
   
   Two things to avoid: do not restate what CI already enforces (lint, format, 
build are checked automatically — a checkbox adds nothing), and keep the 
checklist to items an author can genuinely answer.
   
   Worth reading `CONTRIBUTING.md` first and matching its wording, so the two 
do not drift apart.
   
   ## ASF compliance
   
   A markdown file only — no workflow, no action, nothing that touches the ASF 
third-party Actions allowlist.
   
   ## Verifying
   
   Open a draft PR from a scratch branch and confirm the template pre-fills the 
description. Delete the draft afterwards.
   
   ## Picking this up
   
   No need to be assigned — assignment here is limited to committers. Comment 
that you are starting, then open a PR.
   
   This touches one new file under `.github/`, so it conflicts with nothing 
else currently open.
   


-- 
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