Skip to content
Merged

Dev #57

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 73 additions & 0 deletions .github/PR_TEMPLATES/pr_bugfix.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
<!-- Type: Bugfix -->

# 🐞 Bug Summary
_Short description of the bug + user severity/impact._

Severity: (critical / high / medium / low)

# πŸ” Reproduction
_Minimal steps to reproduce_

1. …
2. …
3. …

**Actual result:**
_What actually happens_

**Expected result:**
_What should happen_

# 🌍 Runtime Context
- Affected version(s):
- Environment(s): (local / staging / prod)
- OS:
- Python:
- Logs/trace ID (if applicable):

# πŸ•΅οΈ Analysis & Root Cause
_What is the root cause? How did you confirm it? Links to traces._

- Confirmed root cause:

# βœ… Applied Fix
_Describe the fix precisely and why it addresses the root cause. Rejected alternatives._

- Affected modules:
- Risks/side effects:

# πŸ§ͺ Tests (including regression)
- [ ] Unit test covering the case
- [ ] Integration/E2E test
- [ ] Non-regression test (bug does not reappear)

**Manual validation procedure:**
1. …
2. …
3. Expected result: …

# πŸš€ Deployment & Rollback
- Deployment steps:
- Rollback plan:
- Backport needed? (versions/LTS):

# πŸ”— Links
Closes # _main issue_
Related: _Related PR/Issues_

# πŸ–ΌοΈ Evidence
_Screenshots, videos, relevant logs (no secrets), minimal requests_
- Screenshots:
- Log excerpts:

---

# βœ… Project checklist
- [ ] All my commits are **signed (GPG/SSH)** in accordance with the [contribution guide](../blob/main/docs/CONTRIBUTING.md)
- [ ] `lint` passes locally and in CI
- [ ] No sensitive data exposed (credentials, tokens)
- [ ] Manual validation completed
- [ ] The added/covered tests are relevant for the feature
- [ ] User/developer documentation is up to date (where applicable)
- [ ] Security/performance impacts have been reviewed
- [ ] I have described a clear manual validation procedure
86 changes: 86 additions & 0 deletions .github/PR_TEMPLATES/pr_ci-cd.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
<!-- Type: CICD -->

# 🎯 Goals

_Summarize in 2–3 sentences **why** this CI/CD PR exists and what it changes._

# πŸ”§ Scope of changes

- [ ] CI/CD workflow modification (GitHub Actions)
- [ ] Template modification
- [ ] Addition/modification of tests

## Modified CI/CD workflows and/or templates

_If applicable, list the modified GitHub Actions workflows or templates_

# πŸ§ͺ Tests

# Tests added/modified

- [ ] Unit tests
- [ ] Integration tests
- [ ] Regression tests

**Details:**
_Describe the test scenarios covered_

# Code coverage

- [ ] Code coverage maintained or improved
- [ ] Current coverage: __%
- [ ] New coverage: __%

# Local execution

- [ ] Tests pass locally (`pytest` or equivalent)
- [ ] Application runs correctly locally

# Version compatibility

- [ ] Postfix:
- [ ] Python:
- [ ] Journald:
- [ ] Syslog:
- [ ] Debian:

# πŸ”’ Security & permissions

- Does this PR reduce/maintain/increase permissions?
- [ ] Reduce
- [ ] Maintain
- [ ] Increase (justify below)

- Justification for elevated permissions (if applicable):
> …

# 🧾 Changelog (CI/CD)

- **Additions:**
- …
- **Modifications:**
- …
- **Deletions:**
- …

# πŸ”— Links
Closes # _main issue_
Related: _Related PR/Issues_

# πŸ“š Docs & communication

- [ ] README / Contributing updated if the workflow changes
- [ ] Inline comments added in YAML to explain design choices
- [ ] Link to design discussion/issue (if any): ________

---

# βœ… Project checklist
- [ ] All my commits are **signed (GPG/SSH)** in accordance with the [contribution guide](../blob/main/docs/CONTRIBUTING.md)
- [ ] `lint` passes locally and in CI
- [ ] No sensitive data exposed (credentials, tokens)
- [ ] Manual validation completed
- [ ] The added/covered tests are relevant for the feature
- [ ] User/developer documentation is up to date (where applicable)
- [ ] Security/performance impacts have been reviewed
- [ ] I have described a clear manual validation procedure
74 changes: 74 additions & 0 deletions .github/PR_TEMPLATES/pr_code.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
<!-- Type: Code -->

# πŸ”Ž Context
_Why this change? Problem / goal._

# ✨ Nature of the change
_Check what applies_

- [ ] Refactor (no functional change)
- [ ] Performance (optimizations)
- [ ] Chore / Tooling
- [ ] Upgrade dependencies
- [ ] Security (hardening, permissions, etc.)
- [ ] Other:

# 🧩 Implementation details
_Impacted files/modules. Design rationale. Considered alternatives._

- Impacted modules:
- Key decisions:

# πŸ›‘οΈ Impacts (Security / Privacy / Performance)
_Sensitive data? Latency/CPU/memory? Cache?_

- Security:
- Privacy:
- Performance:

# πŸ” Compatibility / Breaking changes
_Any breaking change? DB migrations/API contracts?_

- Breaking: Yes / No
- API/contracts:
- DB migrations:

# πŸ§ͺ Tests
- [ ] Unit
- [ ] Integration
- [ ] E2E / manual (describe below)

**Manual validation procedure:**
1. …
2. …
3. Expected result: …

# πŸ“š Documentation
- [ ] README / Docs updated (if needed)
- [ ] Changelog / Release notes

# πŸ”— Dependencies & Flags
- Dependent PRs / services:
- Feature flag/toggle (if used): name, strategy, cleanup date

# πŸ–ΌοΈ Screenshots / Evidence
_Logs, screenshots, before/after, benchmarks, profiles_

- Benchmarks / profiling:
- Screenshots:

# πŸ”— Links
Closes # _main issue_
Related: _Related PR/Issues_

---

# βœ… Project checklist
- [ ] All my commits are **signed (GPG/SSH)** in accordance with the [contribution guide](../blob/main/docs/CONTRIBUTING.md)
- [ ] `lint` passes locally and in CI
- [ ] No sensitive data exposed (credentials, tokens)
- [ ] Manual validation completed
- [ ] The added/covered tests are relevant for the feature
- [ ] User/developer documentation is up to date (where applicable)
- [ ] Security/performance impacts have been reviewed
- [ ] I have described a clear manual validation procedure
44 changes: 44 additions & 0 deletions .github/PR_TEMPLATES/pr_docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
<!-- Type: Documentation -->

# πŸ“ Document purpose
_Summarize what changes and why (fix, addition, overhaul).

# πŸ“š Scope
_List affected files/sections/doc sites_

- Files/sections:
- Target audience: (users / devs / ops)

# πŸ” Context
_What was the problem (gap, outdated docs, ambiguity)?_

# βœ… Content added/modified
_Detail notable changes: new chapters, examples, diagrams, ADR, FAQ_

# πŸ§ͺ Verification
- [ ] Examples/commands have been tested manually
- [ ] Internal/external links work
- [ ] Code snippets compile/run (if applicable)

# πŸ”„ Synchronization with code/product
_Which version/feature flag does this doc correspond to?_

# 🧹 Deprecation
_Sections removed/deprecated; redirects or archive notes_

# πŸ–ΌοΈ Assets
_Screenshots, diagrams, sources (draw.io/Excalidraw) + location of source files_

# πŸ”— Links
Closes # _main issue_
Related: _Related PR/Issues_

---

# βœ… Project checklist
- [ ] All my commits are **signed (GPG/SSH)** in accordance with the [contribution guide](../blob/main/docs/CONTRIBUTING.md)
- [ ] Commits **signed (GPG/SSH)**
- [ ] Markdown/spell linter run (e.g., `markdownlint`, `vale`)
- [ ] Links checked (e.g., `lychee`) and images optimized
- [ ] CHANGELOG updated if needed
- [ ] Consistency with the corresponding version/feature confirmed
64 changes: 64 additions & 0 deletions .github/PR_TEMPLATES/pr_ferature.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
<!-- Type: Feature -->

# 🎯 Description
_What user need? What specific problem?_

# βœ… Proposed solution
_Summarize the solution. Describe the scope and what is explicitly out of scope._

# πŸ–ΌοΈ UI/UX (if applicable)
_Add BEFORE/AFTER screenshots, GIFs, videos._

# 🧨 Breaking changes
_Yes/No. If Yes, detail the impact and the steps for users._
_Check all that apply_

- [ ] New feature (non-breaking change adding functionality)
- [ ] Breaking change (feature causing existing functionality to change)
- [ ] Refactoring (functional changes)
- [ ] Other (please describe):

# βš™οΈ Implementation details
- Impacted modules:
- API contracts changed?:
- DB schema / migrations?:
- etc

# πŸ›‘οΈ Security & πŸ”₯ Performance
_Points of attention: sensitive data, perf, cache, etc._

# πŸ§ͺ Tests
- [ ] Unit tests
- [ ] Integration tests
- [ ] Performance tests (if applicable)

**Test coverage:** _X%_ (before) β†’ _Y%_ (after)

**Manual validation procedure:**
1. …
2. …
3. Expected result: …

# πŸ“š Documentation
- [ ] README / Docs updated
- [ ] Changelog / Release notes (if necessary)

# πŸ”— Dependencies
_External services, migrations to apply before/after._

# πŸ”— Links
Closes # _main issue_
Related: _Related PR/Issues_

---

# βœ… Project checklist
- [ ] All my commits are **signed (GPG/SSH)** in accordance with the [contribution guide](../blob/main/docs/CONTRIBUTING.md)
- [ ] `lint` passes locally and in CI
- [ ] No sensitive data exposed (credentials, tokens)
- [ ] Manual validation completed
- [ ] The added/covered tests are relevant for the feature
- [ ] User/developer documentation is up to date (where applicable)
- [ ] Security/performance impacts have been reviewed
- [ ] I have described a clear manual validation procedure

17 changes: 0 additions & 17 deletions .github/PULL_REQUEST_TEMPLATE.md

This file was deleted.

Loading