Create CONVENTIONS.md to document org-wide development conventions #1

New issue

Closed

opened 2026-05-18 20:23:58 -06:00 by Xeplosion · 2 comments

Xeplosion commented

2026-05-18 20:23:58 -06:00

Owner

Description:

We need a CONVENTIONS.md file in the org repo that documents the agreed upon conventions for all XeplosionGames repositories. This should cover:

Branch naming and structure (master, release).
Commit message format (e.g. capitalized, past tense, with a period).
Issue naming and labeling conventions.
Pull request conventions (when to merge, who reviews).
Deployment conventions (always deploy from release).
Symlink and permissions setup conventions.

Acceptance Criteria:

CONVENTIONS.md exists in XeplosionGames/org.
All existing repos are audited and updated to comply.

## Description: We need a `CONVENTIONS.md` file in the `org` repo that documents the agreed upon conventions for all XeplosionGames repositories. This should cover: - Branch naming and structure (`master`, `release`). - Commit message format (e.g. capitalized, past tense, with a period). - Issue naming and labeling conventions. - Pull request conventions (when to merge, who reviews). - Deployment conventions (always deploy from `release`). - Symlink and permissions setup conventions. ## Acceptance Criteria: - `CONVENTIONS.md` exists in `XeplosionGames/org`. - All existing repos are audited and updated to comply.

Xeplosion added the

Kind/Documentation

Priority

Medium

labels

2026-05-18 20:23:58 -06:00

Xeplosion added this to the Infrastructure & Devops project

2026-05-18 20:23:58 -06:00

Xeplosion commented

2026-05-24 08:20:20 -06:00

Author

Owner

The conventions are now being split into three separate places:

Firstly, still in the org repo under CONVENTIONS.md.

But now, also in the .forgejo repository, and the template repositories the implement its standardized workflows and scrip templates.

And also a newly created Projects Template project, created in the org repo.

The conventions are now being split into three separate places: Firstly, still in the `org` repo under `CONVENTIONS.md`. But now, also in the `.forgejo` repository, and the template repositories the implement its standardized workflows and scrip templates. And also a newly created Projects Template project, created in the `org` repo.

Xeplosion commented

2026-05-24 08:49:35 -06:00

Author

Owner

Closing as resolved — conventions documentation lives in the README.md of the .forgejo repo, which serves as the dedicated conventions and standards reference for the org. A separate CONVENTIONS.md in org or .profile would add unnecessary indirection. The .profile repo will link to .forgejo for contributors. Renaming .forgejo to something more descriptive (e.g. conventions) is tracked separately.

Closing as resolved — conventions documentation lives in the `README.md` of the `.forgejo` repo, which serves as the dedicated conventions and standards reference for the org. A separate `CONVENTIONS.md` in `org` or `.profile` would add unnecessary indirection. The `.profile` repo will link to `.forgejo` for contributors. Renaming `.forgejo` to something more descriptive (e.g. `conventions`) is tracked separately.

Xeplosion closed this issue

2026-05-24 08:49:35 -06:00

Xeplosion added spent time

2026-05-24 08:49:42 -06:00

40 minutes

Xeplosion added the

Reviewed

Confirmed

label

2026-05-25 05:36:29 -06:00