Skip to content

Commit 86a1bc3

Browse files
refactor(root): move root artefacts to their canonical locations (#98)
refactor(root): move root artefacts to their canonical locations Applies the estate root-shape rollout: files that are not root-level by necessity move to where their tooling and the estate canon expect them, and every reference to them is updated in the same change. * .github/hooks/validate-a2ml.sh (from .githooks/validate-a2ml.sh) -> .github/hooks/validate-a2ml.sh * .github/hooks/validate-k9.sh (from .githooks/validate-k9.sh) -> .github/hooks/validate-k9.sh * .github/workflows/dogfood-gate.yml * QUICKSTART-MAINTAINER.adoc * README.adoc * build/guix.scm (from guix.scm) -> build/guix.scm * .github/CONTRIBUTING.md (new) * CONTRIBUTING.adoc (deleted) * QUICKSTART.adoc * docs/accessibility/README.adoc Verified with `git apply --check` against current main before committing; no behaviour change intended, the Justfile entry points keep working.
1 parent 4967c5b commit 86a1bc3

10 files changed

Lines changed: 109 additions & 143 deletions

File tree

‎.github/CONTRIBUTING.md‎

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
# Clone the repository
2+
3+
git clone <https://github.com/hyperpolymath/sanctify-php.git> cd
4+
sanctify-php
5+
6+
# Using Nix (recommended for reproducibility)
7+
8+
nix develop
9+
10+
# Or using toolbox/distrobox
11+
12+
toolbox create sanctify-php-dev toolbox enter sanctify-php-dev \#
13+
Install dependencies manually
14+
15+
# Verify setup
16+
17+
just check \# or: cargo check / mix compile / etc. just test \# Run test
18+
suite
19+
20+
21+
### Repository Structure
22+
23+
sanctify-php/ ├── src/ \# Source code (Perimeter 1-2) ├── lib/ \#
24+
Library code (Perimeter 1-2) ├── extensions/ \# Extensions (Perimeter 2)
25+
├── plugins/ \# Plugins (Perimeter 2) ├── tools/ \# Tooling (Perimeter
26+
2) ├── docs/ \# Documentation (Perimeter 3) │ ├── architecture/ \# ADRs,
27+
specs (Perimeter 2) │ └── proposals/ \# RFCs (Perimeter 3) ├── examples/
28+
\# Examples (Perimeter 3) ├── spec/ \# Spec tests (Perimeter 3) ├──
29+
tests/ \# Test suite (Perimeter 2-3) ├── .well-known/ \# Protocol files
30+
(Perimeter 1-3) ├── .github/ \# GitHub config (Perimeter 1) │ ├──
31+
ISSUE_TEMPLATE/ │ └── workflows/ ├── CHANGELOG.md ├── CODE_OF_CONDUCT.md
32+
├── CONTRIBUTING.md \# This file ├── GOVERNANCE.md ├── LICENSE ├──
33+
MAINTAINERS.md ├── README.adoc ├── SECURITY.md ├── flake.nix \# Nix
34+
flake (Perimeter 1) └── Justfile \# Task runner (Perimeter 1)
35+
36+
37+
---
38+
39+
## How to Contribute
40+
41+
### Reporting Bugs
42+
43+
**Before reporting**:
44+
1. Search existing issues
45+
2. Check if it's already fixed in `main`
46+
3. Determine which perimeter the bug affects
47+
48+
**When reporting**:
49+
50+
Use the [bug report template](.github/ISSUE_TEMPLATE/bug_report.md) and include:
51+
52+
- Clear, descriptive title
53+
- Environment details (OS, versions, toolchain)
54+
- Steps to reproduce
55+
- Expected vs actual behaviour
56+
- Logs, screenshots, or minimal reproduction
57+
58+
### Suggesting Features
59+
60+
**Before suggesting**:
61+
1. Check the [roadmap](ROADMAP.md) if available
62+
2. Search existing issues and discussions
63+
3. Consider which perimeter the feature belongs to
64+
65+
**When suggesting**:
66+
67+
Use the [feature request template](.github/ISSUE_TEMPLATE/feature_request.md) and include:
68+
69+
- Problem statement (what pain point does this solve?)
70+
- Proposed solution
71+
- Alternatives considered
72+
- Which perimeter this affects
73+
74+
### Your First Contribution
75+
76+
Look for issues labelled:
77+
78+
- [`good first issue`](https://github.com/hyperpolymath/sanctify-php/labels/good%20first%20issue) — Simple Perimeter 3 tasks
79+
- [`help wanted`](https://github.com/hyperpolymath/sanctify-php/labels/help%20wanted) — Community help needed
80+
- [`documentation`](https://github.com/hyperpolymath/sanctify-php/labels/documentation) — Docs improvements
81+
- [`perimeter-3`](https://github.com/hyperpolymath/sanctify-php/labels/perimeter-3) — Community sandbox scope
82+
83+
---
84+
85+
## Development Workflow
86+
87+
### Branch Naming
88+
89+
docs/short-description \# Documentation (P3) test/what-added \# Test
90+
additions (P3) feat/short-description \# New features (P2)
91+
fix/issue-number-description \# Bug fixes (P2) refactor/what-changed \#
92+
Code improvements (P2) security/what-fixed \# Security fixes (P1-2)
93+
94+
95+
### Commit Messages
96+
97+
We follow [Conventional Commits](https://www.conventionalcommits.org/):
98+
99+
():
100+
101+
\[optional body\]
102+
103+
\[optional footer\]

‎.github/workflows/dogfood-gate.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ jobs:
3939
4040
- name: Validate A2ML manifests
4141
if: steps.detect.outputs.count > 0
42-
run: bash .githooks/validate-a2ml.sh
42+
run: bash .github/hooks/validate-a2ml.sh
4343
- name: Write summary
4444
run: |
4545
A2ML_COUNT="${{ steps.detect.outputs.count }}"
@@ -83,7 +83,7 @@ jobs:
8383
8484
- name: Validate K9 contracts
8585
if: steps.detect.outputs.k9_count > 0
86-
run: bash .githooks/validate-k9.sh
86+
run: bash .github/hooks/validate-k9.sh
8787
- name: Write summary
8888
run: |
8989
K9_COUNT="${{ steps.detect.outputs.k9_count }}"

‎CONTRIBUTING.adoc‎

Lines changed: 0 additions & 109 deletions
This file was deleted.

‎QUICKSTART-MAINTAINER.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Output: `{{BUILD_OUTPUT_PATH}}`
3131

3232
[source,bash]
3333
----
34-
guix build -f guix.scm
34+
guix build -f build/guix.scm
3535
----
3636

3737
=== Nix

‎QUICKSTART.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -452,7 +452,7 @@ sudo apt-get install libgmp-dev libffi-dev zlib1g-dev
452452
* Read the full documentation: link:docs/USER-GUIDE.adoc[User Guide]
453453
* Explore advanced features: link:docs/ADVANCED.adoc[Advanced Usage]
454454
* Learn about WordPress integration: link:docs/WORDPRESS.adoc[WordPress Guide]
455-
* Contribute to development: link:CONTRIBUTING.adoc[Contributing Guide]
455+
* Contribute to development: link:.github/CONTRIBUTING.md[Contributing Guide]
456456
* Report issues: https://github.com/hyperpolymath/sanctify-php/issues
457457

458458
== Support

‎README.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ cabal install
5151
nix build
5252
5353
# Using Guix
54-
guix build -f guix.scm
54+
guix build -f build/guix.scm
5555
----
5656

5757
== Usage

‎docs/accessibility/README.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,7 @@ Burble is committed to:
243243
* Supporting screen readers and other assistive technologies
244244
* Continuous improvement based on user feedback
245245

246-
We welcome contributions to improve accessibility. See our link:../CONTRIBUTING.adoc[Contributing Guide] for details.
246+
We welcome contributions to improve accessibility. See our link:../../.github/CONTRIBUTING.md[Contributing Guide] for details.
247247

248248
== Related Documents
249249

‎guix.scm‎

Lines changed: 0 additions & 28 deletions
This file was deleted.

0 commit comments

Comments
 (0)