mirror of
https://github.com/bitsocialnet/5chan.git
synced 2026-08-03 07:41:04 +02:00
docs: split AGENTS.md into core policy and on-demand playbooks
2602.12670 and 2602.11988 findings favoring curated, minimal, modular guidance over comprehensive always-on context
This commit is contained in:
@@ -0,0 +1,26 @@
|
||||
# Commit and Issue Format
|
||||
|
||||
Use this when proposing or implementing meaningful code changes.
|
||||
|
||||
## Commit Suggestion Format
|
||||
|
||||
- **Title:** Conventional Commits style, short, wrapped in backticks.
|
||||
- Use `perf` (not `fix`) for performance optimizations.
|
||||
- **Description:** Optional 2-3 informal sentences describing the solution. Concise, technical, no bullet points.
|
||||
|
||||
Example:
|
||||
|
||||
> **Commit title:** `fix: correct date formatting in timezone conversion`
|
||||
>
|
||||
> Updated `formatDate()` in `date-utils.ts` to properly handle timezone offsets.
|
||||
|
||||
## GitHub Issue Suggestion Format
|
||||
|
||||
- **Title:** As short as possible, wrapped in backticks.
|
||||
- **Description:** 2-3 informal sentences describing the problem (not the solution), as if still unresolved.
|
||||
|
||||
Example:
|
||||
|
||||
> **GitHub issue:**
|
||||
> - **Title:** `Date formatting displays incorrect timezone`
|
||||
> - **Description:** Comment timestamps show incorrect timezones when users view posts from different regions. The `formatDate()` function doesn't account for user's local timezone settings.
|
||||
Reference in New Issue
Block a user