Skip to content

Commit d5ca496

Browse files
refactor(root): move root artefacts to their canonical locations (#36)
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. * RSR_OUTLINE.adoc * build/guix.scm (from guix.scm) -> build/guix.scm * .github/CONTRIBUTING.md (new) * CONTRIBUTING.adoc (deleted) Verified with `git apply --check` against current main before committing; no behaviour change intended, the Justfile entry points keep working.
1 parent 232c511 commit d5ca496

4 files changed

Lines changed: 103 additions & 137 deletions

File tree

‎.github/CONTRIBUTING.md‎

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

‎CONTRIBUTING.adoc‎

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

‎RSR_OUTLINE.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ git init
3737
sed -i 's/RSR-template-repo/my-project/g' Justfile guix.scm README.adoc
3838
3939
# Enter development environment
40-
guix shell -D -f guix.scm
40+
guix shell -D -f build/guix.scm
4141
4242
# Validate compliance
4343
just validate-rsr

‎guix.scm‎

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

0 commit comments

Comments
 (0)