Fix heading, scope, version placement, and consistency across policy docs
- Rename REPO_POLICIES.md heading from "Development Policies" to "Repository Policies" to distinguish from code styleguides - Move version line above heading per convention - Add scope statement and links to code styleguide documents - Add missing Makefile and LICENSE to minimum files list - Add version lines to all cross-project docs (CODE_STYLEGUIDE*.md, GO_HTTP_SERVER_CONVENTIONS.md) - Clean up CODE_STYLEGUIDE.md heading (was old repo name) - Update EXISTING_REPO_CHECKLIST.md link text to match new heading
This commit is contained in:
parent
f43445caea
commit
00c21cc5c5
@ -1,15 +1,6 @@
|
|||||||
# sneak/styleguide
|
Version: 2026-02-22
|
||||||
|
|
||||||
The following is the first released version of my personal code styleguide.
|
# Code Styleguide
|
||||||
There are many like it, but this one is mine.
|
|
||||||
|
|
||||||
Only the Go portion is "complete". The others are mostly just placeholders.
|
|
||||||
|
|
||||||
Feedback and suggestions are not only welcome but explicitly encouraged.
|
|
||||||
|
|
||||||
[sneak@sneak.berlin](mailto:sneak@sneak.berlin)
|
|
||||||
|
|
||||||
# My 2024 Code Styleguide
|
|
||||||
|
|
||||||
## All
|
## All
|
||||||
|
|
||||||
|
|||||||
@ -1,3 +1,5 @@
|
|||||||
|
Version: 2026-02-22
|
||||||
|
|
||||||
# Golang
|
# Golang
|
||||||
|
|
||||||
1. Try to hard wrap long lines at 77 characters or less.
|
1. Try to hard wrap long lines at 77 characters or less.
|
||||||
|
|||||||
@ -1,3 +1,5 @@
|
|||||||
|
Version: 2026-02-22
|
||||||
|
|
||||||
# JavaScript / ECMAScript / ES6
|
# JavaScript / ECMAScript / ES6
|
||||||
|
|
||||||
1. Use `const` for everything. If you need to reassign, use `let`. Never use
|
1. Use `const` for everything. If you need to reassign, use `let`. Never use
|
||||||
|
|||||||
@ -1,3 +1,5 @@
|
|||||||
|
Version: 2026-02-22
|
||||||
|
|
||||||
# Python
|
# Python
|
||||||
|
|
||||||
1. Format all code with `black`, with four space indents.
|
1. Format all code with `black`, with four space indents.
|
||||||
|
|||||||
@ -1,7 +1,7 @@
|
|||||||
# Existing Repo Checklist
|
# Existing Repo Checklist
|
||||||
|
|
||||||
Use this checklist when beginning work in a repo that may not yet conform to our
|
Use this checklist when beginning work in a repo that may not yet conform to our
|
||||||
[development policies](https://git.eeqj.de/sneak/prompts/raw/branch/main/prompts/REPO_POLICIES.md).
|
[repository policies](https://git.eeqj.de/sneak/prompts/raw/branch/main/prompts/REPO_POLICIES.md).
|
||||||
|
|
||||||
Work on a feature branch. Check each item and fix any gaps before proceeding
|
Work on a feature branch. Check each item and fix any gaps before proceeding
|
||||||
with your task.
|
with your task.
|
||||||
|
|||||||
@ -1,3 +1,5 @@
|
|||||||
|
Version: 2026-02-22
|
||||||
|
|
||||||
# Go HTTP Server Conventions
|
# Go HTTP Server Conventions
|
||||||
|
|
||||||
This document defines the architectural patterns, design decisions, and
|
This document defines the architectural patterns, design decisions, and
|
||||||
|
|||||||
@ -1,7 +1,19 @@
|
|||||||
# Development Policies
|
|
||||||
|
|
||||||
Version: 2026-02-22
|
Version: 2026-02-22
|
||||||
|
|
||||||
|
# Repository Policies
|
||||||
|
|
||||||
|
This document covers repository structure, tooling, and workflow standards. Code
|
||||||
|
style conventions are in separate documents:
|
||||||
|
|
||||||
|
- [Code Styleguide](https://git.eeqj.de/sneak/prompts/raw/branch/main/prompts/CODE_STYLEGUIDE.md)
|
||||||
|
(general, bash, Docker)
|
||||||
|
- [Go](https://git.eeqj.de/sneak/prompts/raw/branch/main/prompts/CODE_STYLEGUIDE_GO.md)
|
||||||
|
- [JavaScript](https://git.eeqj.de/sneak/prompts/raw/branch/main/prompts/CODE_STYLEGUIDE_JS.md)
|
||||||
|
- [Python](https://git.eeqj.de/sneak/prompts/raw/branch/main/prompts/CODE_STYLEGUIDE_PYTHON.md)
|
||||||
|
- [Go HTTP Server Conventions](https://git.eeqj.de/sneak/prompts/raw/branch/main/prompts/GO_HTTP_SERVER_CONVENTIONS.md)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
- Cross-project documentation (such as this file) must include a
|
- Cross-project documentation (such as this file) must include a
|
||||||
`Version: YYYY-MM-DD` line near the top so it can be kept in sync with the
|
`Version: YYYY-MM-DD` line near the top so it can be kept in sync with the
|
||||||
authoritative source as policies evolve.
|
authoritative source as policies evolve.
|
||||||
@ -143,7 +155,8 @@ Version: 2026-02-22
|
|||||||
|
|
||||||
- New repos must contain at minimum:
|
- New repos must contain at minimum:
|
||||||
- `README.md`, `.git`, `.gitignore`, `.editorconfig`
|
- `README.md`, `.git`, `.gitignore`, `.editorconfig`
|
||||||
- `REPO_POLICIES.md` (copy from the `prompts` repo)
|
- `LICENSE`, `REPO_POLICIES.md` (copy from the `prompts` repo)
|
||||||
|
- `Makefile`
|
||||||
- `Dockerfile`, `.dockerignore`
|
- `Dockerfile`, `.dockerignore`
|
||||||
- `.gitea/workflows/check.yml`
|
- `.gitea/workflows/check.yml`
|
||||||
- Go: `go.mod`, `go.sum`, `.golangci.yml`
|
- Go: `go.mod`, `go.sum`, `.golangci.yml`
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user