Skip to content

Commit 57ae0b6

Browse files
Update CONTRIBUTING.md
1 parent 36ea4f3 commit 57ae0b6

1 file changed

Lines changed: 106 additions & 9 deletions

File tree

CONTRIBUTING.md

Lines changed: 106 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,122 @@
1+
2+
3+
14
<p align="center">
2-
<img src="ChatGPT%20Image%202%20okt%202025%2C%2022_33_51.png" alt="PAXECT logo" width="200"/>
5+
<img src="docs/ChatGPT%20Image%202%20okt%202025,%2022_22_22.png" alt="PAXECT logo" width="200"/>
36
</p>
47

5-
68
# Contributing Guidelines
79

8-
Thank you for your interest in contributing to the **PAXECT SelfTune Plugin**.
10+
Welcome, and thank you for your interest in contributing to **PAXECT SelfTune**!
11+
Your effort helps keep the project deterministic, reproducible, and cross-platform across all major operating systems.
912

1013
---
1114

12-
## Overview
15+
## Overview
16+
17+
**PAXECT SelfTune** is part of the broader **PAXECT Interface** ecosystem.
18+
All contributions must remain **deterministic**, **platform-agnostic**, and **dependency-light**
19+
no AI, telemetry, or random behavior is allowed.
1320

14-
This repository is part of the **PAXECT Interface** ecosystem.
15-
All contributions must remain deterministic, platform-agnostic, and free of external dependencies or AI/ML components.
21+
SelfTune focuses on **runtime control**, **adaptive overhead regulation**, and **deterministic performance tuning**.
22+
Every contribution must preserve bit-identical outputs across all runs and platforms.
1623

1724
---
1825

19-
## Development Setup
26+
## Development Setup
27+
28+
1. **Fork** this repository to your own GitHub account.
29+
30+
2. **Clone** your fork locally:
2031

21-
1. Fork this repository.
22-
2. Clone your fork locally:
2332
```bash
2433
git clone https://github.com/PAXECT-Interface/paxect-selftune-plugin.git
2534
cd paxect-selftune-plugin
35+
```
36+
37+
3. **Create a virtual environment** (recommended):
38+
39+
```bash
40+
python3 -m venv .venv
41+
source .venv/bin/activate # On Windows: .venv\Scripts\activate
42+
```
43+
44+
4. **Install dependencies**:
45+
46+
```bash
47+
pip install -r requirements.txt
48+
```
49+
50+
5. **Verify deterministic behavior** before making changes:
51+
52+
```bash
53+
python demos/selftune_enterprise_demo_01_standalone.py
54+
python demos/selftune_enterprise_demo_02_safety_throttle.py
55+
python demos/selftune_enterprise_demo_03_adaptive_benchmark.py
56+
python demos/selftune_enterprise_demo_04_metrics_server.py
57+
```
58+
59+
> 🧩 Each demo must complete without drift or deviation between runs —
60+
> investigate any inconsistent metrics before submitting code.
61+
62+
---
63+
64+
## Contribution Rules
65+
66+
* Keep commits focused and clear.
67+
Example:
68+
`fix: stabilize throttle timing on Windows` or
69+
`feat: add deterministic smoothing interval`.
70+
* All files must include SPDX headers:
71+
72+
```python
73+
# SPDX-FileCopyrightText: © 2025 PAXECT
74+
# SPDX-License-Identifier: Apache-2.0
75+
```
76+
* Test on **at least two operating systems** (Linux + Windows/macOS).
77+
* Avoid adding randomness, pseudo-AI logic, or heuristic parameters.
78+
* All pull requests must pass **CI + CodeQL** validation.
79+
80+
---
81+
82+
## Pull Request Workflow
83+
84+
1. Create a new feature branch:
85+
86+
```bash
87+
git checkout -b feature/your-change
88+
```
89+
2. Push your changes:
90+
91+
```bash
92+
git push origin feature/your-change
93+
```
94+
3. Open a **Pull Request** describing the goal and rationale.
95+
4. Maintainers will review determinism, platform parity, and structure.
96+
5. Once approved, your PR will be merged and scheduled for the next release.
97+
98+
> ✨ The goal: measurable, deterministic progress — not arbitrary speed.
99+
100+
---
101+
102+
## Communication
103+
104+
* **Issues:** for bug reports, enhancement ideas, and reproducibility concerns
105+
* **Discussions:** for architecture or policy refinement
106+
* **Security:** please see [SECURITY.md](./SECURITY.md) for responsible disclosure
107+
108+
---
109+
110+
## Thank You 💛
111+
112+
Every contribution helps make **PAXECT SelfTune** a stronger, fairer, and more predictable component in the PAXECT ecosystem.
113+
Your technical precision and time are deeply appreciated.
114+
115+
> Together we keep PAXECT deterministic, safe, and reproducible — across all environments.
116+
117+
---
118+
119+
120+
121+
Wil je dat ik deze meteen aanpas voor de **AEAD Hybrid Plugin** daarna (zelfde structuur, maar met encryptie-focus)?
122+

0 commit comments

Comments
 (0)