Peer Review by T14 - CD Fall, FODA - General - Use of symbolic constants
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 62/100
- Issue type
- Refactor
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- tex
- Domain
- documentation
Research direction
Open the FODA folder and read the A1 constants text file alongside the CD Fall document to see where player health minimums and maximums are written as literals. Move those limits into A1 as named symbolic constants, reference them from the CD Fall text, and add a short justification for each value. Done when no raw health numbers remain in the CD Fall description and every constant is defined once in A1; check with the reviewing team (@MelvinMo) that the naming matches their conventions.
Written by the indexing model from the issue text.
Description
Artifact Under Review
CD Fall, FODA
Team Number for Team Doing the Review
Team Number 14
Description of Issue
- The included ranges and system values, especially since they are subject to change, should be represented by symbolic constraints
- The FODA folder already contains an A1 constants text file, which could be used to hold these symbolic constraints
- Applicable to max and min player health
- This would also provide a good spot to justify any values or changes when done
Closing Remarks
- Good content, the use of the variables would just make it cleaner to make changes
@MelvinMo
- Dominant language
- TeX
- Stars
- 0
- Forks
- 0
- Avg merge
- 1d 7h
- Merged PRs (30d)
- 52
Getting set up
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from Aeolus-Software/RealmForge
-
documentation Peer Review
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Aeolus-Software/RealmForge#321 ·
Maintainers usually reply within 1 day
-
documentation Feedback Response Revision
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
Aeolus-Software/RealmForge#318 ·
Maintainers usually reply within 1 day
-
documentation Feedback Response Revision
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
Aeolus-Software/RealmForge#315 ·
Maintainers usually reply within 1 day
-
TA Feedback Response to Hazard Analysis: Critical AssumptionsPossibly taken @AH-Huynh942 claimed this 13 days ago. Opendocumentation Feedback Response Revision
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
Aeolus-Software/RealmForge#241 · 1 assignee ·
Maintainers usually reply within 1 day
-
Peer Review Feedback Response to #37: Environment VagueMay be free again @johnso9 claimed this 33 days ago, and no pull request is open. Opendocumentation Feedback Response
Difficulty 1/5 Under an hour Newbie friendliness 68/100
Aeolus-Software/RealmForge#117 · 1 assignee ·
Maintainers usually reply within 1 day
All issues in Aeolus-Software/RealmForge
Similar issues
-
backlog-skill cat:docs documentation effort:s ready-for-agent sev:low
Difficulty 1/5 Under an hour Newbie friendliness 82/100
LucasSantana-Dev/Lucky#3284 ·
Maintainers usually reply within 1 day
-
Custom namespace instructions imply icon child classes are renamedPossibly taken @nemo-crypto claimed this today. Open
Difficulty 1/5 Under an hour Newbie friendliness 82/100
-
bug good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 80/100
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 85/100
janitor-team/janitor#2592 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
drmrd/vernacular#1061 ·
Maintainers usually reply within 1 day