Review and finalize CONVENTION.md stack sections #8

New issue

Open

opened 2026-06-15 17:47:52 -06:00 by Xeplosion · 0 comments

Xeplosion commented

2026-06-15 17:47:52 -06:00

Owner

What question are we trying to answer?

Are the stack-specific sections of CONVENTION.md accurate and complete for
each stack used across XeplosionGames repos? Several sections were written with
reasonable defaults and judgment calls that need to be verified or corrected
against actual project usage.

Specific questions per stack:

.NET / MonoGame — Is XeplosionGames.<Project>.<Module> the correct
namespace root? Does the naming convention match what's already in use in
existing MonoGame projects?
Node — Has a test framework been settled on (Jest, Vitest, or other)?
The current doc leaves this open.
PHP — Should private properties use _camelCase ($_spawnTimer) or
plain camelCase ($spawnTimer)? Visibility is declared explicitly in PHP
so the underscore prefix is a style choice.
Python — Are the Ruff rules (E, F, I minimum) appropriate? Any
additional rules to enable or disable?
Scripts — Is the shell script convention complete, or are there additional
patterns in use that should be documented?

Why does this matter?

CONVENTION.md is the single source of truth for how all XeplosionGames repos
are written. Inaccurate conventions create confusion and inconsistency across
stacks. This needs to be correct before it's referenced by contributors.

Scope and time box

In scope:

Review each stack section in CONVENTION.md against existing projects
Identify any incorrect, missing, or ambiguous conventions
Confirm or correct all judgment calls listed above
Out of scope:
Enforcing conventions retroactively on existing repos
Adding new stacks not already in the document
Time box: ~2 hours

Definition of done

A PR to CONVENTION.md on the docs branch with all stack sections confirmed
or corrected. If no changes are needed, close with a comment confirming each
section was reviewed.

Checklist

The question is clearly defined
There is a time box or deadline in mind
I know what the output should look like

### What question are we trying to answer? Are the stack-specific sections of `CONVENTION.md` accurate and complete for each stack used across XeplosionGames repos? Several sections were written with reasonable defaults and judgment calls that need to be verified or corrected against actual project usage. Specific questions per stack: - **.NET / MonoGame** — Is `XeplosionGames.<Project>.<Module>` the correct namespace root? Does the naming convention match what's already in use in existing MonoGame projects? - **Node** — Has a test framework been settled on (Jest, Vitest, or other)? The current doc leaves this open. - **PHP** — Should private properties use `_camelCase` (`$_spawnTimer`) or plain `camelCase` (`$spawnTimer`)? Visibility is declared explicitly in PHP so the underscore prefix is a style choice. - **Python** — Are the Ruff rules (`E`, `F`, `I` minimum) appropriate? Any additional rules to enable or disable? - **Scripts** — Is the shell script convention complete, or are there additional patterns in use that should be documented? ### Why does this matter? `CONVENTION.md` is the single source of truth for how all XeplosionGames repos are written. Inaccurate conventions create confusion and inconsistency across stacks. This needs to be correct before it's referenced by contributors. ### Scope and time box In scope: - Review each stack section in `CONVENTION.md` against existing projects - Identify any incorrect, missing, or ambiguous conventions - Confirm or correct all judgment calls listed above Out of scope: - Enforcing conventions retroactively on existing repos - Adding new stacks not already in the document Time box: ~2 hours ### Definition of done A PR to `CONVENTION.md` on the `docs` branch with all stack sections confirmed or corrected. If no changes are needed, close with a comment confirming each section was reviewed. ### Checklist - [x] The question is clearly defined - [x] There is a time box or deadline in mind - [x] I know what the output should look like

Xeplosion added the

labels

2026-06-15 17:47:52 -06:00