You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: expand STYLE_GUIDE.md into the opinionated 3.0 style guide
Replaces the initial stub with a full-length style guide that takes
concrete positions on the axes previously flagged as open:
+ IsX vs is-X predicate naming is settled in favor of IsX
(stdlib-compatible, already canonical in Setoid/Homomorphisms/
Basic and Demos/HSP).
+ Record-vs-Σ guidance: Algebra stays a record; classical structures
are Σ-typed with record-typed bundle views for stdlib interop.
+ The canonical symbol table is populated (projections, levels,
algebras, equivalence, orders, set-theoretic, products,
interpretation, term algebra).
+ ∣_∣ / ∥_∥ are announced as deprecated in favor of proj₁ / proj₂;
the mechanical migration is scoped to M4-1, with the rationale to
land as an ADR under M1-6.
Adds five guiding principles (one canonical form per concept,
stdlib-compat when possible, proof terms as training data, Cubical
portability by construction, document the mathematics) and concrete
checklists for opening, reviewing, and auditing PRs.
Paths referenced for Classical/, Cubical/, and Legacy/Base/ are
forward-looking; a note at the top calls this out.
Addresses #253 (M1-4).
plus `module X.Y.Z where` on the next non-comment line.
@@ -81,7 +81,7 @@ As of the 3.0 reconstruction, all of `src/` uses `--cubical-compatible`. When t
81
81
+**Predicates** are typically named `IsX` for "X-ness of a single thing" (e.g. `IsHomomorphism`) and `X` for "the type of things with property X" (e.g. `Homomorphism`).
82
82
+ Avoid synonyms. If the concept is already called `Hom` elsewhere, call it `Hom` here too.
83
83
84
-
A proper style guide, `docs/STYLE.md`, is tracked in M1-4 and will land shortly. Until then, the convention is "follow the style of the surrounding code, and when in doubt ask in the PR."
84
+
A proper style guide, `docs/STYLE_GUIDE.md`, is tracked in M1-4 and will land shortly. Until then, the convention is "follow the style of the surrounding code, and when in doubt ask in the PR."
Copy file name to clipboardExpand all lines: README.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -60,7 +60,7 @@ Older versions of either component are **not** supported on the `master` branch.
60
60
61
61
## Contributing
62
62
63
-
Contributions are welcome. See [`CONTRIBUTING.md`](CONTRIBUTING.md) for the development workflow and conventions, and [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md) for community standards. The style guide ([`docs/STYLE.md`](docs/STYLE.md)) is being drafted as part of Milestone 1; see [`docs/GITHUB_PROJECT.md`](docs/GITHUB_PROJECT.md) for the full roadmap.
63
+
Contributions are welcome. See [`CONTRIBUTING.md`](CONTRIBUTING.md) for the development workflow and conventions, and [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md) for community standards. The style guide ([`docs/STYLE_GUIDE.md`](docs/STYLE_GUIDE.md)) is being drafted as part of Milestone 1; see [`docs/GITHUB_PROJECT.md`](docs/GITHUB_PROJECT.md) for the full roadmap.
64
64
65
65
For questions about mathematical content or large design changes, open a GitHub issue
66
66
labeled `design-discussion` before writing code.
@@ -143,7 +143,7 @@ To cite the [formalization of Birkhoff's HSP Theorem](https://ualib.org/Setoid.V
143
143
}
144
144
```
145
145
146
-
If you're looking for the latest (setoid-based) formalization of Brkhoff's Theorem, see the [Proof of the HSP Theorem](https://ualib.org/Setoid.Varieties.HSP.html#proof-of-the-hsp-theorem) in the html documentation, or the source code of the [Setoid.Varieties.HSP][] module in the file [Setoid/Varieties/HSP.lagda][] in the [agda-algebras][] GitHub repository.
146
+
If you're looking for the latest (setoid-based) formalization of Brkhoff's Theorem, see the [Proof of the HSP Theorem](https://ualib.org/Setoid.Varieties.HSP.html#proof-of-the-hsp-theorem) in the html documentation, or the source code of the [Setoid.Varieties.HSP][] module.
147
147
148
148
---
149
149
@@ -175,5 +175,5 @@ If you're looking for the latest (setoid-based) formalization of Brkhoff's Theor
175
175
[Formalization of Universal Algebra in Agda]: https://www.sciencedirect.com/science/article/pii/S1571066118300768
176
176
[Introduction to Univalent Foundations of Mathematics with Agda]: https://www.cs.bham.ac.uk/~mhe/HoTT-UF-in-Agda-Lecture-Notes/
177
177
[Programming Languages Foundations in Agda]: https://plfa.github.io/
Copy file name to clipboardExpand all lines: docs/GITHUB_PROJECT.md
+17-17Lines changed: 17 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -54,7 +54,7 @@ agda-algebras was released as v2.0.1 in December 2021 ([Zenodo DOI 10.5281/zenod
54
54
55
55
**Description**. Modernize the library's tooling, establish baseline project hygiene, and unblock every subsequent milestone. The library is currently pinned to Agda 2.6.2 / stdlib 1.7; it must move to Agda 2.8.0 / stdlib v2.3 with `--cubical-compatible` replacing `--without-K`. Standard community-health files (CONTRIBUTING, CHANGELOG, CODE_OF_CONDUCT, STYLE) must land. GitHub Actions CI must stand up. README and installation docs must be rewritten for the 3.0 line.
56
56
57
-
**Exit criterion**. `make check` passes under GitHub Actions CI against Agda 2.8.0 / stdlib v2.3; CONTRIBUTING.md, docs/STYLE.md, ROADMAP.md, CHANGELOG.md are merged; README documents the new install path.
57
+
**Exit criterion**. `make check` passes under GitHub Actions CI against Agda 2.8.0 / stdlib v2.3; CONTRIBUTING.md, docs/STYLE_GUIDE.md, ROADMAP.md, CHANGELOG.md are merged; README documents the new install path.
### Milestone 4 — Style and naming uniformity sweep
82
82
83
-
**Description**. Apply `docs/STYLE.md` consistently across `Setoid/` and `Classical/`. Audit naming (one preferred name per concept; synonyms deprecated); audit notation (one canonical symbol table); audit module structure (one concept per module where feasible); ensure every user-facing definition has a prose comment block.
83
+
**Description**. Apply `docs/STYLE_GUIDE.md` consistently across `Setoid/` and `Classical/`. Audit naming (one preferred name per concept; synonyms deprecated); audit notation (one canonical symbol table); audit module structure (one concept per module where feasible); ensure every user-facing definition has a prose comment block.
84
84
85
-
**Exit criterion**. No undocumented public definitions remain in `Setoid/` or `Classical/`; no synonym pairs (e.g. `is-homomorphism` + `IsHom`) exist in the public API; the canonical symbol table in `docs/STYLE.md` matches the notation actually used in the library.
85
+
**Exit criterion**. No undocumented public definitions remain in `Setoid/` or `Classical/`; no synonym pairs (e.g. `is-homomorphism` + `IsHom`) exist in the public API; the canonical symbol table in `docs/STYLE_GUIDE.md` matches the notation actually used in the library.
86
86
87
87
---
88
88
@@ -249,24 +249,24 @@ Standard community-health files are missing. Drafts of CONTRIBUTING and STYLE e
249
249
250
250
---
251
251
252
-
### Issue M1-4: Adopt docs/STYLE.md as the project style guide
252
+
### Issue M1-4: Adopt docs/STYLE_GUIDE.md as the project style guide
253
253
254
254
**Labels**: `milestone-1-infra`, `documentation`
255
255
256
256
**Milestone**: 1 — Infrastructure health
257
257
258
258
## Description
259
259
260
-
Create `docs/STYLE.md` documenting file format, module structure, naming conventions, notation, universe-polymorphism practices, record vs Σ guidance, proof style, and library-as-training-corpus considerations. A draft from the planning cycle is ready for review. Applying the style guide across `Setoid/` and `Classical/` is tracked in M4-1.
260
+
Create `docs/STYLE_GUIDE.md` documenting file format, module structure, naming conventions, notation, universe-polymorphism practices, record vs Σ guidance, proof style, and library-as-training-corpus considerations. A draft from the planning cycle is ready for review. Applying the style guide across `Setoid/` and `Classical/` is tracked in M4-1.
261
261
262
262
## Tasks
263
263
264
-
-[ ] Merge `docs/STYLE.md` (draft from planning cycle).
265
-
-[ ] Link `STYLE.md` from `README.md` and `CONTRIBUTING.md`.
264
+
-[ ] Merge `docs/STYLE_GUIDE.md` (draft from planning cycle).
265
+
-[ ] Link `STYLE_GUIDE.md` from `README.md` and `CONTRIBUTING.md`.
266
266
267
267
## Acceptance criteria
268
268
269
-
-[ ]`docs/STYLE.md` is merged.
269
+
-[ ]`docs/STYLE_GUIDE.md` is merged.
270
270
-[ ] Links from README and CONTRIBUTING work.
271
271
272
272
---
@@ -285,7 +285,7 @@ The current `README.md` and `docs/lagda/Preface.lagda` are 1.x-era: wrong Agda v
0 commit comments