Skip to content

Commit d86b6dc

Browse files
marjatmm-secmarjatmm-sec
committed
docs: update README to v0.2, add collaboration infrastructure
- README: updated results (6-qubit, Q 99.55/100%/F1=1.000), feature vector v2 (24-dim), 8-tab architecture, detection verdicts table, Sigma corpus section, replay generator, VQC optimisation, corrected GPU latency - CONTRIBUTING.md: Qute-specific setup, branch conventions, PR checklist - SECURITY.md: responsible disclosure policy and scope - CODE_OF_CONDUCT.md: Contributor Covenant 2.1 - PR template: Qute-specific checklist with benchmark/migration requirements - Issue templates: updated bug report (GPU field), feature request, question
1 parent 8511f85 commit d86b6dc

8 files changed

Lines changed: 445 additions & 109 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
name: Bug report
3+
about: Something isn't working as expected
4+
title: '[BUG] '
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
## Description
10+
11+
<!-- A clear description of the bug. -->
12+
13+
## Steps to reproduce
14+
15+
1.
16+
2.
17+
3.
18+
19+
## Expected behaviour
20+
21+
<!-- What should have happened? -->
22+
23+
## Actual behaviour
24+
25+
<!-- What happened instead? -->
26+
27+
## Environment
28+
29+
- OS:
30+
- Python version:
31+
- CUDA-Q version:
32+
- GPU: (e.g. RTX 2080 Ti, or CPU-only)
33+
- Docker: yes / no
34+
- Qute version / commit:
35+
36+
## Logs
37+
38+
```
39+
<!-- Paste relevant log output here -->
40+
```
41+
42+
## Additional context
43+
44+
<!-- Screenshots, related issues, anything else helpful. -->

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: Feature request
3+
about: Suggest a new capability or improvement
4+
title: '[FEATURE] '
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
## Summary
10+
11+
<!-- One sentence description of the feature. -->
12+
13+
## Motivation
14+
15+
<!-- Why is this needed? What problem does it solve? -->
16+
17+
## Proposed approach
18+
19+
<!-- How might this be implemented? (Optional — just ideas welcome) -->
20+
21+
## Alternatives considered
22+
23+
<!-- Any other approaches you've thought about? -->
24+
25+
## Additional context
26+
27+
<!-- Related issues, research papers, prior art, screenshots. -->

‎.github/ISSUE_TEMPLATE/question.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
name: Question
3+
about: Ask something about setup, usage, or the project
4+
title: '[QUESTION] '
5+
labels: question
6+
assignees: ''
7+
---
8+
9+
## Question
10+
11+
<!-- What would you like to know? -->
12+
13+
## Context
14+
15+
<!-- What are you trying to do? What have you already tried? -->
16+
17+
## Environment (if relevant)
18+
19+
- OS:
20+
- Python version:
21+
- GPU:

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
## Description
2+
3+
<!-- What does this PR do? Why is it needed? Link to the related issue if one exists. -->
4+
5+
Closes #
6+
7+
## Type of change
8+
9+
- [ ] Bug fix
10+
- [ ] New feature
11+
- [ ] Detection rule addition
12+
- [ ] Feature vector / VQC change
13+
- [ ] Documentation update
14+
- [ ] Performance improvement
15+
- [ ] Refactor (no functional change)
16+
17+
## Checklist
18+
19+
- [ ] Targets `dev` branch, not `main`
20+
- [ ] No credentials, API keys, or personal data committed
21+
- [ ] All modified Python files pass syntax check (`python3 -m py_compile <file>`)
22+
- [ ] Feature vector changes include benchmark evidence (`scripts/optimise_vqc_params.py`)
23+
- [ ] Schema changes include a migration in `src/store/migrations.py`
24+
- [ ] `scripts/recompute_feature_vectors.py` run if feature vector changed
25+
- [ ] README updated if behaviour or project structure changed
26+
27+
## Test evidence
28+
29+
<!-- Paste relevant benchmark results, log output, or screenshots. -->
30+
31+
## Notes for reviewer
32+
33+
<!-- Anything the reviewer should know about implementation decisions, trade-offs, or known limitations. -->

‎CODE_OF_CONDUCT.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Code of Conduct
2+
3+
## Our pledge
4+
5+
We as contributors and maintainers pledge to make participation in Qute a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, colour, religion, or sexual identity and orientation.
6+
7+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
8+
9+
## Our standards
10+
11+
Examples of behaviour that contributes to a positive environment:
12+
13+
- Demonstrating empathy and kindness toward other people
14+
- Being respectful of differing opinions, viewpoints, and experiences
15+
- Giving and gracefully accepting constructive feedback
16+
- Accepting responsibility and apologising to those affected by our mistakes, and learning from the experience
17+
- Focusing on what is best not just for us as individuals, but for the overall community
18+
19+
Examples of unacceptable behaviour:
20+
21+
- The use of sexualised language or imagery, and sexual attention or advances of any kind
22+
- Trolling, insulting or derogatory comments, and personal or political attacks
23+
- Public or private harassment
24+
- Publishing others' private information, such as a physical or email address, without their explicit permission
25+
- Other conduct which could reasonably be considered inappropriate in a professional setting
26+
27+
## Enforcement responsibilities
28+
29+
Maintainers are responsible for clarifying and enforcing our standards of acceptable behaviour and will take appropriate and fair corrective action in response to any behaviour that they deem inappropriate, threatening, offensive, or harmful.
30+
31+
## Scope
32+
33+
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces.
34+
35+
## Enforcement
36+
37+
Instances of abusive, harassing, or otherwise unacceptable behaviour may be reported to the maintainer via the contact details on the GitHub profile associated with this repository. All complaints will be reviewed and investigated promptly and fairly.
38+
39+
## Attribution
40+
41+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.1.

‎CONTRIBUTING.md‎

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
# Contributing to Qute
2+
3+
Thank you for your interest in contributing. Qute (Quantum Unified Threat Engine) is a local-first quantum-classical hybrid threat detection system built on CUDA-Q, DuckDB, and Streamlit. Contributions that improve detection accuracy, extend the feature vector, add new attack simulations, or improve the user experience are welcome.
4+
5+
---
6+
7+
## Before you start
8+
9+
**Please open an issue before writing code.** This avoids wasted effort if a feature is already in progress, outside scope, or planned differently. For bug fixes, an issue also helps confirm the bug is reproducible and understood before a fix is attempted.
10+
11+
---
12+
13+
## Development setup
14+
15+
**Requirements:**
16+
- Python 3.11
17+
- CUDA-Q 0.14.0 (or compatible)
18+
- Docker + Docker Compose (for GPU build)
19+
- NVIDIA GPU recommended for VQC benchmarking
20+
21+
**Quick start:**
22+
```bash
23+
git clone https://github.com/marjatmm-sec/qute
24+
cd qute
25+
git checkout dev
26+
27+
# CPU-only (no GPU required)
28+
pip install -r requirements.txt
29+
streamlit run src/ui/app.py
30+
31+
# GPU build (recommended)
32+
docker compose up --build
33+
```
34+
35+
**Running the optimiser:**
36+
```bash
37+
python3 scripts/optimise_vqc_params.py --trials 8 --maxiter 2000
38+
```
39+
40+
**Recomputing feature vectors after changes:**
41+
```bash
42+
python3 scripts/recompute_feature_vectors.py
43+
```
44+
45+
---
46+
47+
## Branch conventions
48+
49+
```
50+
main ← stable, protected, tagged releases only
51+
dev ← integration branch, default for PRs
52+
```
53+
54+
- All work targets `dev` — never commit directly to `main`
55+
- `main` is updated only via PR from `dev` at stable milestones
56+
- Branch protection rules are configured but not enforced on the private repo — please self-enforce the convention
57+
58+
---
59+
60+
## What we will and won't merge
61+
62+
**Will merge:**
63+
- Bug fixes with a clear reproduction case
64+
- New Sigma detection rules (40 rules currently across Linux/Windows/Network)
65+
- Feature vector extensions with justification and benchmark evidence
66+
- New attack simulation factories in `replay.py`
67+
- UI improvements that don't break existing tabs
68+
- Documentation improvements
69+
- Performance improvements to the VQC pipeline
70+
71+
**Won't merge:**
72+
- Features that require cloud APIs or send data off the local machine
73+
- Changes that break the local/privacy-preserving nature of the project
74+
- VQC parameter changes without benchmark evidence showing improvement
75+
- Breaking changes to the DB schema without a migration in `migrations.py`
76+
- Features without a clear security detection use case
77+
78+
The maintainer reserves the right to decline PRs that don't fit the project direction, even if technically correct.
79+
80+
---
81+
82+
## PR checklist
83+
84+
- [ ] Targets `dev` branch, not `main`
85+
- [ ] No credentials, API keys, or personal data committed
86+
- [ ] All modified Python files pass syntax check (`python3 -m py_compile`)
87+
- [ ] Feature vector changes accompanied by benchmark results
88+
- [ ] Schema changes include a migration in `src/store/migrations.py`
89+
- [ ] README updated if behaviour or project structure changed
90+
- [ ] PR description explains what changed and why
91+
92+
---
93+
94+
## Reporting security vulnerabilities
95+
96+
Please do **not** open a public issue for security vulnerabilities in Qute itself. See [SECURITY.md](SECURITY.md) for the responsible disclosure process.
97+
98+
---
99+
100+
## Licence
101+
102+
By contributing to Qute, you agree that your contributions will be licensed under the [MIT License](LICENSE).

0 commit comments

Comments
 (0)