Skip to content

Add: Refactor requirements doc#383

Draft
suspect15 wants to merge 1 commit into
RetroAchievements:mainfrom
suspect15:refactor-reqs
Draft

Add: Refactor requirements doc#383
suspect15 wants to merge 1 commit into
RetroAchievements:mainfrom
suspect15:refactor-reqs

Conversation

@suspect15

Copy link
Copy Markdown
Contributor

Adds a requirements doc for refactored inactive developer sets. The purpose of this is to establish a standard for bringing substandard, inactive developer sets up to current quality standards to ensure long term stability and easiest possible future maintenance.

@suspect15 suspect15 marked this pull request as draft June 15, 2026 11:44

- Bracketed size at the beginning of every note, may include BE or BCD as appropriate [16-bit BE], [16-bit BCD], [16-bit BE BCD]
- Bitflags shall not be bracketed, but may be included in the note description, not required though as seeing values as bits makes it clear that the address contains bitflags
- Address description in clear, concise verbiage - may expand as needed, but should not unnecessarily

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sentence here ends abruptly and feels like more words should follow "but should not unnecessarily"

I think the intent from context is to not unnecessarily expand description

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants