Skip to content

Commit 76e411e

Browse files
committed
minor
1 parent fd95a93 commit 76e411e

6 files changed

Lines changed: 65 additions & 34 deletions

File tree

.editorconfig

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# ============================================================
22
# .editorconfig (Standardize across editors and IDEs)
33
# ============================================================
4+
# Updated: 2024-06-04
45
# REQ.UNIVERSAL: All professional GitHub project repositories MUST include .editorconfig.
56
# WHY: Establish a cross-editor baseline so diffs stay clean and formatting is consistent.
67
# ALT: Repository may omit .editorconfig ONLY if formatting is enforced equivalently by CI and formatter tooling.

.gitattributes

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# ============================================================
2-
# .gitattributes (Cross-platform line endings, GH languages)
2+
# .gitattributes (Keep files consistent across operating systems)
33
# ============================================================
44
# Updated: 2026-06-04
55

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
# ============================================================
2+
# .gitignore (Keep unnecessary files out of the repository)
3+
# ============================================================
4+
15
# REQ.UNIVERSAL: Spec repositories MUST ignore editor, OS, and transient artifacts.
26
# WHY: Prevent accidental commits of local or generated noise.
37
# ALT: Expand only if the repository adds tooling that generates artifacts.

.markdownlint-cli2.yaml

Lines changed: 35 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -8,56 +8,65 @@
88
# Run with:
99
# npx markdownlint-cli2 --fix
1010

11+
# === Set the scope of files to check ===
12+
13+
# Check these types of files
1114
globs:
1215
- "**/*.md"
1316

17+
# Do not check these files or directories
1418
ignores:
1519
- ".lake/**"
1620
- "**/.lake/**"
17-
- ".venv/**"
18-
- "**/.venv/**"
19-
- "node_modules/**"
20-
- "**/node_modules/**"
21-
- "site/**"
22-
- "**/site/**"
23-
- "dist/**"
24-
- "**/dist/**"
25-
- "build/**"
26-
- "**/build/**"
27-
- ".ruff_cache/**"
28-
- "**/.ruff_cache/**"
29-
- ".pytest_cache/**"
30-
- "**/.pytest_cache/**"
3121
- ".mypy_cache/**"
3222
- "**/.mypy_cache/**"
23+
- ".nox/**"
24+
- "**/.nox/**"
3325
- ".pyright/**"
3426
- "**/.pyright/**"
27+
- ".pytest_cache/**"
28+
- "**/.pytest_cache/**"
29+
- ".ruff_cache/**"
30+
- "**/.ruff_cache/**"
3531
- ".tox/**"
3632
- "**/.tox/**"
37-
- ".nox/**"
38-
- "**/.nox/**"
3933
- ".uv-cache/**"
4034
- "**/.uv-cache/**"
35+
- ".venv/**"
36+
- "**/.venv/**"
37+
- "build/**"
38+
- "**/build/**"
39+
- "dist/**"
40+
- "**/dist/**"
4141
- "htmlcov/**"
4242
- "**/htmlcov/**"
43+
- "node_modules/**"
44+
- "**/node_modules/**"
45+
- "site/**"
46+
- "**/site/**"
4347
- "LICENSE"
4448
- "CODEOWNERS"
4549

50+
51+
# === Configure rules ===
52+
4653
config:
47-
default: true # WHY: This enables all default rules, which is a good starting point for linting Markdown files.
54+
55+
default: true # WHY: Enables all default rules, which is a good starting point for linting Markdown files.
4856

4957
MD013:
5058
line_length: 100
51-
headings: false # WHY: This allows long headings, which can be necessary for clarity and SEO in Markdown files.
52-
tables: false # WHY: This allows long table cells, which can be necessary for readability and completeness in Markdown files.
53-
code_blocks: false # WHY: This allows long lines in code blocks, which can be necessary for readability and completeness in Markdown files.
59+
headings: false # WHY: Allows long headings for clarity and SEO in Markdown files.
60+
tables: false # WHY: Allows long table cells for readability and completeness in Markdown files.
61+
code_blocks: false # WHY: Allows long lines in code blocks for readability and completeness in Markdown files.
5462

55-
MD025: false # WHY: This allows multiple top-level headings, which can be necessary in Markdown files that are not strictly linear documents (e.g., README files, documentation index files).
63+
MD025: false # WHY: Allow multiple H1 headings when a file is not a linear document.
5664

5765
MD033:
5866
allowed_elements:
59-
- mark # WHY: Mark elements are often used in Markdown files for highlighting, and this allows them without triggering a lint error.
60-
- meta # WHY: Metadata is often needed in Markdown files, and this allows it without triggering a lint error.
61-
- link # WHY: Links are common in Markdown files, and this allows them without triggering a lint error.
62-
- details # WHY: Details elements are often used in Markdown files, and this allows them without triggering a lint error.
63-
- summary # WHY: Summary elements are often used in Markdown files, and this allows them without triggering a lint error.
67+
- details # collapsible sections
68+
- img # images
69+
- link # links
70+
- mark # highlighting
71+
- meta # metadata
72+
- summary # summary elements

.pre-commit-config.yaml

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
# ============================================================
22
# .pre-commit-config.yaml (Markdown Hygiene)
33
# ============================================================
4-
# Updated: 2026-05-23
5-
6-
# Fast, consistent repo hygiene before commit.
4+
# Updated: 2026-06-04
5+
# WHY: Fast, consistent repo hygiene before commit.
76
#
87
# These hooks complement and do not replace:
98
# - .editorconfig
@@ -20,8 +19,8 @@
2019

2120
exclude: |
2221
(?x)^(
23-
\.DS_Store|
2422
\.coverage|
23+
\.DS_Store|
2524
\.ipynb_checkpoints/|
2625
\.mypy_cache/|
2726
\.nox/|
@@ -30,6 +29,7 @@ exclude: |
3029
\.tox/|
3130
\.venv/|
3231
.*\.(egg-info)/|
32+
.*\.log|
3333
__pycache__/|
3434
_minted.*/|
3535
build/|
@@ -39,8 +39,9 @@ exclude: |
3939
lake-packages/|
4040
node_modules/|
4141
out/|
42-
site/ |
43-
LICENSE
42+
site/|
43+
LICENSE|
44+
CODEOWNERS
4445
)
4546
4647
repos:

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ uvx pre-commit install
4747
npx markdownlint-cli2 --fix
4848
uvx pre-commit run --all-files
4949

50-
# generate CODEOWNERS and check
50+
# generate and check CODEOWNERS
5151
uvx se-codeowners generate --strict --output .github/CODEOWNERS
5252
uvx se-codeowners check
5353

@@ -71,3 +71,19 @@ git push -u origin main
7171
git tag vX.Y.Z -m "X.Y.Z"
7272
git push origin vX.Y.Z
7373
```
74+
75+
## Authority Manifest
76+
77+
[.accountability/surfaces.toml](./.accountability/surfaces.toml)
78+
79+
## Citation
80+
81+
[CITATION.cff](./CITATION.cff)
82+
83+
## License
84+
85+
[MIT](./LICENSE)
86+
87+
## Repository Manifest
88+
89+
[SE_MANIFEST.toml](./SE_MANIFEST.toml)

0 commit comments

Comments
 (0)