Skip to content

Commit cb58380

Browse files
committed
new: [gpt] AGENTS.md codex /init
1 parent 11a122f commit cb58380

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

AGENTS.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Repository Guidelines
2+
3+
## Project Structure & Module Organization
4+
- `content/` houses Markdown with TOML front matter; subfolders mirror site navigation and service areas.
5+
- `layouts/` overrides theme templates; keep page partials grouped by section to avoid collisions.
6+
- `assets/` collects SCSS and pipeline assets compiled by Hugo Extended.
7+
- `static/` serves images and downloads verbatim; store heavy media externally and link here.
8+
- `data/` exposes YAML/TOML snippets consumed by shortcodes, ideal for project inventories.
9+
- `themes/` includes `kode` (active) and `hugo-arcana`; treat them as git submodules and avoid direct edits without upstream PRs.
10+
11+
## Build, Test, and Development Commands
12+
- `hugo server -D --disableFastRender` starts a local preview with drafts and reloads assets on each request.
13+
- `hugo --minify --gc` produces the production bundle in `public/`, pruning unused fingerprinted assets.
14+
- `git submodule update --init --recursive` syncs theme sources after cloning or switching branches.
15+
16+
## Coding Style & Naming Conventions
17+
- Author content in Markdown with TOML front matter; use snake_case filenames for multi-word slugs.
18+
- Wrap prose near 100 characters and prefer semantic Markdown (lists, tables) over ad-hoc HTML.
19+
- Keep SCSS indented with two spaces and rely on Hugo Pipes; do not commit compiled CSS.
20+
21+
## Testing Guidelines
22+
- Verify new pages via `hugo server` and watch for console warnings about missing resources or broken links.
23+
- Before pushing, run `hugo --minify` locally and open `public/index.html` to spot layout regressions.
24+
- The repository has no automated unit tests; document manual verification steps in the pull request description.
25+
26+
## Commit & Pull Request Guidelines
27+
- Follow the existing `type: [scope] message` pattern (e.g., `new: [project] Add Range42`) and keep messages imperative.
28+
- Group related changes per commit, separating content edits from theme updates to ease review.
29+
- Pull requests should link related issues, describe the change, list manual checks, and attach screenshots for UI adjustments.
30+
31+
## Security & Configuration Tips
32+
- Global settings live in `config/_default/`; review `params.toml` before introducing site-wide toggles.
33+
- The default `theme_kode` branch deploys via `.github/workflows/hugo.yml`; keep the pinned Hugo Extended (0.108.0) and Dart Sass versions updated together when bumping.

0 commit comments

Comments
 (0)