Skip to content

Commit 51e5870

Browse files
Enhance CONTRIBUTING.md with setup and workflow details
Expanded contributing guidelines with detailed setup and workflow instructions.
1 parent 13d8f63 commit 51e5870

1 file changed

Lines changed: 129 additions & 0 deletions

File tree

paxect-core-complete-CONTRIBUTING.md

Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,130 @@ All contributions must follow the same key principles that define PAXECT:
2626
2727
---
2828

29+
30+
31+
## Development Setup
32+
33+
1. **Fork this repository**
34+
```bash
35+
git clone https://github.com/PAXECT-Interface/paxect-core-complete.git
36+
cd paxect-core-complete
37+
38+
39+
2. **Create a virtual environment**
40+
41+
```bash
42+
python3 -m venv venv
43+
source venv/bin/activate # Windows: venv\Scripts\activate
44+
```
45+
3. **Install dependencies**
46+
47+
```bash
48+
pip install -e .
49+
```
50+
4. **Run demo verification**
51+
52+
```bash
53+
python demos/demo_01_quick_start.py
54+
```
55+
56+
You should see a deterministic `[OK]` output.
57+
58+
---
59+
60+
## Contributing Workflow
61+
62+
1. **Create a new branch**
63+
64+
```bash
65+
git checkout -b feature/your-feature-name
66+
```
67+
2. **Make deterministic changes only**
68+
69+
* Avoid timestamps, random UUIDs, or nondeterministic data.
70+
* Ensure reproducible outputs before committing.
71+
3. **Add / update tests**
72+
73+
* Include demo or validation runs when applicable.
74+
* Demos are preferred over unit tests for full-system verification.
75+
4. **Commit clearly**
76+
77+
```bash
78+
git commit -m "Add: reproducible checksum validation for Polyglot bridge"
79+
```
80+
5. **Submit a Pull Request**
81+
82+
* PRs must pass all CI checks before review.
83+
* Use Discussions for early feedback or design questions.
84+
85+
---
86+
87+
## Code Style & Validation
88+
89+
* **Language:** Python 3.9 – 3.12
90+
* **Linting:** `flake8`, `black` (default settings)
91+
* **Static Analysis:** CodeQL runs automatically on PRs
92+
* **Output format:** human-readable log + JSONL state (deterministic only)
93+
94+
Run quick checks:
95+
96+
```bash
97+
pytest -q
98+
python demos/demo_02_integration_loop.py
99+
```
100+
101+
---
102+
103+
## Communication
104+
105+
For collaboration, questions, or feature ideas:
106+
107+
* 💬 [GitHub Discussions](../../discussions)
108+
* 🐛 [Issues](../../issues)
109+
* 📧 **[PAXECT-Team@outlook.com](mailto:PAXECT-Team@outlook.com)** (for maintainers & enterprise contact)
110+
111+
---
112+
113+
## Governance
114+
115+
* All contributions are reviewed by maintainers under the **CODEOWNERS** policy.
116+
* Core and brand-sensitive changes require **Owner approval**.
117+
* By contributing, you agree to the [Code of Conduct](./CODE_OF_CONDUCT.md).
118+
119+
Perfect ⚙️ — hier komt bestand **4️⃣ — `CONTRIBUTING.md`** voor **PAXECT Core Complete**,
120+
met jouw vaste logo-header en zakelijke maar toegankelijke toon (zoals jij het wilt: professioneel, een vleugje speels, en 100 % open-source-ready).
121+
122+
---
123+
124+
## 🧾 **PAXECT Core Complete — CONTRIBUTING.md**
125+
126+
````markdown
127+
<p align="center">
128+
<img src="docs/ChatGPT%20Image%202%20okt%202025,%2022_22_22.png" alt="PAXECT logo" width="200"/>
129+
</p>
130+
131+
# Contributing Guidelines — PAXECT Core Complete
132+
133+
Thank you for your interest in contributing to **PAXECT Core Complete**!
134+
This repository represents the verified reference bundle for all core PAXECT modules —
135+
**Core**, **AEAD Hybrid**, **Polyglot**, **SelfTune**, and **Link** — designed for deterministic, cross-platform reproducibility.
136+
137+
---
138+
139+
## Overview
140+
141+
All contributions must follow the same key principles that define PAXECT:
142+
143+
- ✅ **Deterministic by design** — no randomness, no nondeterministic side-effects
144+
- ✅ **Offline-first** — no external telemetry, APIs, or network dependencies
145+
- ✅ **Cross-OS consistency** — must behave identically on Linux, macOS, and Windows
146+
- ✅ **No AI / ML components** — SelfTune is purely algorithmic, not heuristic
147+
- ✅ **Security hygiene** — no hard-coded secrets; all config via environment variables
148+
149+
> _In short: every contribution must keep PAXECT reproducible, portable, and auditable._
150+
151+
---
152+
29153
## Development Setup
30154

31155
1. **Fork this repository**
@@ -123,6 +247,11 @@ Let’s build reproducible innovation — together.
123247
124248
© 2025 **PAXECT Systems**. All rights reserved.
125249
250+
```
251+
252+
---
253+
254+
126255

127256

128257

0 commit comments

Comments
 (0)