bcgov / bcgov/foi-flow

Opening and closing the template modal

Open
#388 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 a FOI Analyst
* I want to Select a Template
* so that I can quickly communicate with others about a request

**Assumptions & Scope**
We assume there are a list of static templates to select from (will include db models and APIs)
Templates will be based on status of request.
Edits to templates will be templates, and most recent version will be available for selection.

In scope: Opening and closing modal
Not in scope: Selecting a template and generating a letter - use placeholders instead.

**Acceptance Criteria**

**Scenario 1: Clicking on Compose Template button will generate selection modal**
* GIVEN ... I am on the Email Details page of the Correspondence Log
https://jacklyn808742.invisionapp.com/console/share/3W2O64AP5C/657932512
* WHEN ... I click on "Compose Template" button
* THEN ... the "Select Template" modal pops up
https://jacklyn808742.invisionapp.com/console/share/3W2O64AP5C/657932512

**Scenario 2: Closing the modal by clicking on Return button**
* GIVEN ... I am viewing the "Select Template" modal
* https://jacklyn808742.invisionapp.com/console/share/3W2O64AP5C/657932512
* WHEN ... I click on the "Return to Correspondence button"
* THEN ... the modal disappears and I am taken back to the Email Details page of the Correspondence Log
* https://jacklyn808742.invisionapp.com/console/share/3W2O64AP5C/657932512

**Scenario 3: Closing the modal by clicking on eXit button**
* GIVEN ... I am viewing the "Select Template" modal
* https://jacklyn808742.invisionapp.com/console/share/3W2O64AP5C/657932512
* WHEN ... I click on the "X" button in the top right corner of the modal
* THEN ... the modal disappears and I am taken back to the Email Details page of the Correspondence Log
* https://jacklyn808742.invisionapp.com/console/share/3W2O64AP5C/657932512
...

**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**
https://jacklyn808742.invisionapp.com/console/share/3W2O64AP5C/657932512

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

No implementation file or test is named. Start from the Email Details page of the Correspondence Log and use the linked InVision design to trace the Compose Template action; done means the Select Template modal opens and both Return to Correspondence and the top-right X close it.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
frontend
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 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.