Skip to content

Commit 42d694a

Browse files
Create paxect-core-complete-CONTRIBUTING.md
1 parent 3f51f81 commit 42d694a

1 file changed

Lines changed: 126 additions & 0 deletions

File tree

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
2+
<p align="center">
3+
<img src="docs/ChatGPT%20Image%202%20okt%202025,%2022_22_22.png" alt="PAXECT logo" width="200"/>
4+
</p>
5+
6+
# Contributing Guidelines — PAXECT Core Complete
7+
8+
Thank you for your interest in contributing to **PAXECT Core Complete**!
9+
This repository represents the verified reference bundle for all core PAXECT modules —
10+
**Core**, **AEAD Hybrid**, **Polyglot**, **SelfTune**, and **Link** — designed for deterministic, cross-platform reproducibility.
11+
12+
---
13+
14+
## Overview
15+
16+
All contributions must follow the same key principles that define PAXECT:
17+
18+
-**Deterministic by design** — no randomness, no nondeterministic side-effects
19+
-**Offline-first** — no external telemetry, APIs, or network dependencies
20+
-**Cross-OS consistency** — must behave identically on Linux, macOS, and Windows
21+
-**No AI / ML components** — SelfTune is purely algorithmic, not heuristic
22+
-**Security hygiene** — no hard-coded secrets; all config via environment variables
23+
24+
> _In short: every contribution must keep PAXECT reproducible, portable, and auditable._
25+
26+
---
27+
28+
## Development Setup
29+
30+
1. **Fork this repository**
31+
```bash
32+
git clone https://github.com/PAXECT-Interface/paxect-core-complete.git
33+
cd paxect-core-complete
34+
````
35+
36+
2. **Create a virtual environment**
37+
38+
```bash
39+
python3 -m venv venv
40+
source venv/bin/activate # Windows: venv\Scripts\activate
41+
```
42+
3. **Install dependencies**
43+
44+
```bash
45+
pip install -e .
46+
```
47+
4. **Run demo verification**
48+
49+
```bash
50+
python demos/demo_01_quick_start.py
51+
```
52+
53+
You should see a deterministic `[OK]` output.
54+
55+
---
56+
57+
## Contributing Workflow
58+
59+
1. **Create a new branch**
60+
61+
```bash
62+
git checkout -b feature/your-feature-name
63+
```
64+
2. **Make deterministic changes only**
65+
66+
* Avoid timestamps, random UUIDs, or nondeterministic data.
67+
* Ensure reproducible outputs before committing.
68+
3. **Add / update tests**
69+
70+
* Include demo or validation runs when applicable.
71+
* Demos are preferred over unit tests for full-system verification.
72+
4. **Commit clearly**
73+
74+
```bash
75+
git commit -m "Add: reproducible checksum validation for Polyglot bridge"
76+
```
77+
5. **Submit a Pull Request**
78+
79+
* PRs must pass all CI checks before review.
80+
* Use Discussions for early feedback or design questions.
81+
82+
---
83+
84+
## Code Style & Validation
85+
86+
* **Language:** Python 3.9 – 3.12
87+
* **Linting:** `flake8`, `black` (default settings)
88+
* **Static Analysis:** CodeQL runs automatically on PRs
89+
* **Output format:** human-readable log + JSONL state (deterministic only)
90+
91+
Run quick checks:
92+
93+
```bash
94+
pytest -q
95+
python demos/demo_02_integration_loop.py
96+
```
97+
98+
---
99+
100+
## Communication
101+
102+
For collaboration, questions, or feature ideas:
103+
104+
* 💬 [GitHub Discussions](../../discussions)
105+
* 🐛 [Issues](../../issues)
106+
* 📧 **[PAXECT-Team@outlook.com](mailto:PAXECT-Team@outlook.com)** (for maintainers & enterprise contact)
107+
108+
---
109+
110+
## Governance
111+
112+
* All contributions are reviewed by maintainers under the **CODEOWNERS** policy.
113+
* Core and brand-sensitive changes require **Owner approval**.
114+
* By contributing, you agree to the [Code of Conduct](./CODE_OF_CONDUCT.md).
115+
116+
---
117+
118+
### Thank You!
119+
120+
Your contribution helps keep **PAXECT** deterministic, open, and enterprise-grade.
121+
Let’s build reproducible innovation — together.
122+
123+
© 2025 **PAXECT Systems**. All rights reserved.
124+
125+
```
126+

0 commit comments

Comments
 (0)