bcgov / bcgov/tfrs

TFRS - Exclusion Report Changelog UI - Complete the Exclusion Reports, Report History Tab Changelog

Open
#2,013 2 comments 0 reactions 0 assignees View on GitHub
Medium Story
Dominant language
Python
Stars
25
Forks
39
PR merge metrics
No merged PRs in 30d

Description

**Description**
Currently the Exclusion Report Changelog shows the changes made to a supplemental report but used back-end code language in the UI for labeling these changes. This is confusing for TFRS users.

We need to update this view to match the newly created Compliance Report Changelog UI. Use the same style of component and logic to implement the exclusion report changelog.

Use the similar style of this wireframe:
https://preview.uxpin.com/f727aca33d80cb2a585f76fe43cc583c2f548b07#/pages/119620817?mode=fm

**Expected Behaviour**
When completed, the changes should be shown in the UI to make it easy to view and understand for the user. Essentially replacing the backend code wording with plain language and presenting it in a more appropriate manner.

**Actual Behaviour**
Currently, the “Report History” Tab under an Exclusion Report lists the changes however, they are listed in code.

**Implications**
This is difficult for users to understand and decipher.

**Steps to reproduce the behaviour:**
User/Role: IDIR
1. Go to 'TFRS dashboard in TEST and click on the “Compliance & Exclusions Reports” Tab.'
2. Click on 'Organizations and filer for “South Coast Fuels” and open the 2022 Exclusion Report and navigate to the “Report History” tab.'
3. Scroll down to 'To “Changelog for Exclusion Report for 2022 -- Supplemental Report #1”.'
4. See error – You will note that under the part that says “Exclusion Report for 2022 -- Supplemental Report #1” the change shows changes presented in code.

Contributor guide

Open the contributing guide

Research direction

Start with the existing Compliance Report Changelog UI and compare it with the Exclusion Report's Report History tab. Follow the reproduction steps for the 2022 Exclusion Report and review the linked wireframe for the intended presentation. Done means the exclusion report changelog uses the same style and shows understandable plain-language changes instead of backend code wording.

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.