Skip to content

Commit 2a273b4

Browse files
committed
chore: more docs
1 parent 9573268 commit 2a273b4

File tree

1 file changed

+26
-1
lines changed

1 file changed

+26
-1
lines changed

docs/2024_code_review.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# Looking for '2024' in the app
2+
13
## Registration
24

35
- Date of first shipment for operations \*\*\*
@@ -30,7 +32,7 @@
3032
- allocated_for_compliance_2024 is calculated no matter what (along with the general compliance value)
3133
- "emissions attributable for compliance" and each products "allocated compliance emissions" use the 2024-specific value
3234
- excess/credited emissions also use the 2024-specific allocation
33-
- tests for compliance service (test_compliance_service_static.py) also only test 2024 scenarios
35+
- tests for compliance service (test_compliance_service_static.py, infrastrucutre.py) also only test 2024 scenarios
3436

3537
## Service
3638

@@ -50,3 +52,26 @@
5052
- jsonSchema/complianceSummary.ts
5153

5254
- lots of compliance tests use 2024 as a base when they don't really have to
55+
56+
### Registration:
57+
58+
- View Facility: Did this facility begin operations in 2024 or 2025?
59+
- Create Facility: Did this facility begin operations in 2024 or 2025?
60+
- New entrant: date of first shipment is before or after Apr 1 2024?
61+
62+
### Reporting
63+
64+
- Reporting a product will always show the Jan-Apr production
65+
66+
# `ReportingYearService'
67+
68+
- Could throw an exception if there is no reporting year defined for the current date
69+
- Could also include the ReportingYearDataAccessService functionality (or inversely)
70+
71+
# `ReportingYear` model
72+
73+
- Report validation tests use 2024 as a base year, which may or may not be special
74+
75+
# Recommendations
76+
77+
- make clear to the user what the current reporting year is, from the dashboard to all the relevant views

0 commit comments

Comments
 (0)