11# Clone the repository
22
3- git clone < https://github.com/hyperpolymath/cloudguard-cli.git > cd
4- cloudguard-cli
3+ git clone https://github.com/hyperpolymath/cloudguard-cli.git
4+ cd cloudguard-cli
55
66# Using Guix (recommended for reproducibility)
77
88guix develop
99
1010# Or using toolbox/distrobox
1111
12- toolbox create cloudguard-cli-dev toolbox enter cloudguard-cli-dev \#
13- Install dependencies manually
12+ toolbox create cloudguard-cli-dev
13+ toolbox enter cloudguard-cli-dev
14+ # Install dependencies manually
1415
1516# Verify setup
1617
17- just check \# or: cargo check / mix compile / etc. just test \# Run test
18- suite
19-
20-
21- ### Repository Structure
22-
23- cloudguard-cli/ ├── 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) ├── .machine_readable/ \# ALL
30- machine-readable content (Perimeter 1) │ ├── \* .a2ml \# State files
31- (STATE, META, ECOSYSTEM, etc.) │ ├── bot_directives/ \# Bot configs │
32- └── contractiles/ \# Policy contracts (k9, dust, lust, must, trust) ├──
33- .well-known/ \# Protocol files (Perimeter 1-3) ├── .github/ \# GitHub
18+ just check # or: cargo check / mix compile / etc.
19+ just test # Run test suite
20+
21+ ### Repository Structure
22+
23+ cloudguard-cli/ ├── 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) ├── .machine_readable/ # ALL
30+ machine-readable content (Perimeter 1) │ ├── \* .a2ml # State files
31+ (STATE, META, ECOSYSTEM, etc.) │ ├── bot_directives/ # Bot configs │
32+ └── contractiles/ # Policy contracts (k9, dust, lust, must, trust) ├──
33+ .well-known/ # Protocol files (Perimeter 1-3) ├── .github/ # GitHub
3434config (Perimeter 1) │ ├── ISSUE_TEMPLATE/ │ └── workflows/ ├──
35- CHANGELOG.md ├── CODE_OF_CONDUCT.md ├── CONTRIBUTING.md \ # This file ├──
35+ CHANGELOG.md ├── CODE_OF_CONDUCT.md ├── CONTRIBUTING.md # This file ├──
3636GOVERNANCE.md ├── LICENSE ├── MAINTAINERS.md ├── README.adoc ├──
37- SECURITY.md ├── flake.guix \ # Guix flake — fallback (Perimeter 1) ├──
38- guix.scm \ # Guix package — primary (Perimeter 1) └── Justfile \ # Task
37+ SECURITY.md ├── flake.guix # Guix flake — fallback (Perimeter 1) ├──
38+ guix.scm # Guix package — primary (Perimeter 1) └── Justfile # Task
3939runner (Perimeter 1)
4040
4141
4242 ---
4343
44- ## How to Contribute
44+ ## How to Contribute
4545
46- ### Reporting Bugs
46+ ### Reporting Bugs
4747
4848 **Before reporting**:
4949 1. Search existing issues
@@ -60,7 +60,7 @@ runner (Perimeter 1)
6060 - Expected vs actual behaviour
6161 - Logs, screenshots, or minimal reproduction
6262
63- ### Suggesting Features
63+ ### Suggesting Features
6464
6565 **Before suggesting**:
6666 1. Check the [roadmap](ROADMAP.md) if available
@@ -76,7 +76,7 @@ runner (Perimeter 1)
7676 - Alternatives considered
7777 - Which perimeter this affects
7878
79- ### Your First Contribution
79+ ### Your First Contribution
8080
8181 Look for issues labelled:
8282
@@ -87,22 +87,25 @@ runner (Perimeter 1)
8787
8888 ---
8989
90- ## Development Workflow
90+ ## Development Workflow
9191
92- ### Branch Naming
92+ ### Branch Naming
9393
94- docs/short-description \ # Documentation (P3) test/what-added \ # Test
95- additions (P3) feat/short-description \ # New features (P2)
96- fix/issue-number-description \ # Bug fixes (P2) refactor/what-changed \ #
97- Code improvements (P2) security/what-fixed \ # Security fixes (P1-2)
94+ docs/short-description # Documentation (P3) test/what-added # Test
95+ additions (P3) feat/short-description # New features (P2)
96+ fix/issue-number-description # Bug fixes (P2) refactor/what-changed #
97+ Code improvements (P2) security/what-fixed # Security fixes (P1-2)
9898
9999
100- ### Commit Messages
100+ ### Commit Messages
101101
102102 We follow [Conventional Commits](https://www.conventionalcommits.org/):
103103
104- ():
104+ type(scope): description
105+
106+ Body: what changed and why.
105107
108+ Footer: issue reference, e.g. Closes #123
106109\[ optional body\]
107110
108111\[ optional footer\]
0 commit comments