bcgov / bcgov/foi-flow

Edit Redirect letter

Open
#162 0 comments 0 reactions 0 assignees View on GitHub
Story
Dominant language
Python
Stars
8
Forks
2
Avg merge
14h 34m
Merged PRs (30d)
46

Description

* As an Intake analyst
* I want to edit templated redirect letters before sending to the applicant
* so that I can provide custom information based on the applicant's unique needs

**Assumptions & Scope**
What are the assumptions for this story?

What is in and not in scope?
In scope: editing and saving
Not in scope: sending correspondence, printing

**Acceptance Criteria**

**Scenario 1: Edit letter**
* GIVEN an analyst has generated the Redirect letter:
* WHEN the analyst clicks into the letter
* THEN the analyst can edit the entirety of the letter

**Scenario 2: Save edits**
* GIVEN an analyst has made changes to the letter
* WHEN the analyst clicks the "Save Changes to Template" button
* THEN the letter will be saved with the changes applied
* AND the analyst will be returned to the Correspondence page: https://jacklyn808742.invisionapp.com/console/FOI---Intake-ckpq19frj032r013q6gpm8t1m/ckpx6mtxp012b013ef9jmfpgx/play

**Scenario 3: Exit without saving**
* GIVEN an analyst has made changes to the letter
* AND the analyst has not clicked the "Save Changes to Template" button
* WHEN the analyst clicks the X in the right corner OR the Return to Correspondence button
* THEN a window will pop up with the message "Are you sure you want to leave? Your changes will be lost"
* AND the analyst clicks Yes
* THEN the changes will not be applied and the analyst will be returned to the Correspondence page: https://jacklyn808742.invisionapp.com/console/FOI---Intake-ckpq19frj032r013q6gpm8t1m/ckpx6mtxp012b013ef9jmfpgx/play

**Scenario 4: Cancel exit without saving**
* GIVEN an analyst has made changes to the letter
* AND the analyst has not clicked the "Save Changes to Template" button
* WHEN the analyst clicks the X in the right corner OR the Return to Correspondence button
* THEN a window will pop up with the message "Are you sure you want to leave? Your changes will be lost"
* AND the analyst clicks Cancel
* THEN the analyst will be returned the letter with the changes still applied

**Dependencies? What is the impact of this dependency? (If so, link dependency in the ticket, make it visible in a team´s backlog)**

**Validation Rules? (If yes, list here)**

**Design**
@xxx - please link the Design here

**Definition of Ready**

1. [ ] Is there a well articulated User Story?
2. [ ] Is there Acceptance Criteria that covers all scenarios (happy/sad paths)?
3. [ ] If there is a user interface, is there a design?
4. [ ] Does the user story need user research/validation?
5. [ ] Does this User Story needs stakeholder approval?
6. [ ] Design / Solution accepted by Product Owner
7. [ ] Is this user story small enough to be completed in a Sprint? Should it be split?
8. [ ] Are the dependencies known/ understood? (technical, business, regulatory/policy)
9. [ ] Has the story been estimated?

**Definition of Done**

1. [ ] Passes developer unit tests
2. [ ] Passes peer code review
3. [ ] If there's a user interface, passes UX assurance
4. [ ] Passes QA of Acceptance Criteria with verification in Dev and Test
5. [ ] Confirm Test cases built and succeeding
6. [ ] No regression test failures
7. [ ] Test coverage acceptable by Product Owner
8. [ ] Ticket ready to be merged to master or story branch
9. [ ] Developer to list Config changes/ Update documents and designs
10. [ ] Can be demoed in Sprint Review
11. [ ] Tagged as part of a Release
12. [ ] Feature flagged if required
13. [ ] Change Management activities done?

Contributor guide

Open the contributing guide

Research direction

Start with the Correspondence page and the generated Redirect letter flow described in the acceptance criteria. Review how the letter is opened, edited, saved, and exited, including the confirmation dialog for unsaved changes. Done means all four scenarios work, saved changes return to Correspondence, and cancelled exits preserve edits.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
frontend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.