Peer Review by T14 - CD Fall, FODA - General - Use of symbolic constants

Open Beginner friendly
#322 0 comments 0 reactions 0 assignees View on GitHub

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

documentation Peer Review

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

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Aeolus-Software/RealmForge

All issues in Aeolus-Software/RealmForge

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.