Peer Review Feedback Response to #152: S.5 Prioritization Conflicts with P.4

Open
#199 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
55/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Tech stack
latex
Domain
documentation

Research direction

The priorities live in the SRS source, so start with the Prioritization section (S.5) and the P.4 section it must agree with. Compare each action item's priority level in both places and align them, then lower some high-priority items in S.5 as the second action asks. Done when the same items carry the same priority in both sections and the document still builds.

Written by the indexing model from the issue text.

Description

documentation Feedback Response Revision

Description of the Feedback

Inside the SRS document, the Prioritization section has certain action items at low/mediun priority while in other sections of the document the same action items are high priority. The action items are also mostly in high priority making it not too helpful if large sections need to be cut or time.

Actions to be taken

  • Review the action items and ensure they match with P.4 by editing whichever section has the more accurate priority level
  • Review S.5 and lower some of the high priority action items to create a more useful document which will help if major cuts need to be made
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.