Skip to content

Add PR template and PR style rules - #33

Merged
ArjunS07 merged 3 commits into
mainfrom
docs/pr-style
Oct 20, 2026
Merged

ArjunS07 merged 3 commits into
mainfrom
docs/pr-style

Conversation

@ArjunS07

@ArjunS07 ArjunS07 commented Sep 26, 2026 •

Copy link
Copy Markdown
Contributor

Purpose

PR descriptions in this repo use a fixed style. The rules were only in chat and in memory notes. This PR puts them in the repo, so every author and every agent uses the same rules.

How it works

GitHub fills a new PR description from the template. The template links to the rules page.

.github/
└── pull_request_template.md   # new: section skeleton with one-line prompts
docs/
└── PR_STYLE.md                # new: the rules and one small example

Changes

  1. PR template.
    • Effect: a new PR opens with the sections Purpose, How it works, Changes, Usage, Verification and Notes. It has no footer.
    • Before: a new PR opened with an empty description.
  2. Style rules page.
    • Effect: the language rules (ASD-STE100), section order, math format, banned words and code rules are in one short file.
    • Before: the rules were not in the repo.
    • The page also says that a PR has no footer and no AI attribution, and that commits have no co-author or session trailers.

Verification

  • Documentation only. No code changes.
  • The example in docs/PR_STYLE.md follows its own rules.

Notes

@ArjunS07
ArjunS07 merged commit 966e0f3 into main Oct 20, 2026
0 of 3 checks passed
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.

1 participant