Add issue templates, contribution guidelines, and code of conduct; update CI/CD workflows and project metadata (#3)

Signed-off-by: Hans Kokx <hans.d.kokx@gmail.com> Reviewed-on: #3
2026-05-13 14:13:57 +02:00
parent db0c862e79
commit 5987eba14b
13 changed files with 441 additions and 7 deletions
@@ -0,0 +1,62 @@
+---
+name: 🐛 Bug Report
+about: Report a reproducible bug to help us improve the project
+title: "[bug]: "
+labels: bug
+assignees: ""
+---
+
+<!-- 🛑 **Please fill out the information below. Issues missing the required information will be automatically closed** 🛑 -->
+
+### Checklist
+
+- [ ] I have searched existing issues to ensure this bug hasn’t been reported yet.  
+- [ ] I have provided enough information for others to reproduce this bug.
+- [ ] I have encountered this issue at least twice
+- [ ] I have filled out all the information below
+
+> ⚠️ Please do not open an issue if you've encountered the undesired behavior only once.
+> Document your findings and include them in an issue when you can encounter the issue at least a second time
+
+## Description
+
+**Type**  
+
+- [ ] 💥 Crash  
+- [ ] ✖️ Build error  
+- [ ] 🫨 Instability  
+- [ ] 🤔 Other (please specify):
+
+**Encountered Behavior**  
+<!-- What happened? -->
+
+**Expected Behavior**  
+<!-- What should have happened instead? -->
+
+**Steps/Code Snippet to Reproduce**  
+<!-- Provide minimal, self-contained code or exact steps -->
+
+**Git Hash / Commit ID**  
+<!-- Paste the output of `git rev-parse HEAD` -->
+
+---
+
+## System Specs
+
+- **CPU** (model + architecture):  
+- **GPU** (model + driver version):
+- **Operating System & Version**:  
+- **Compiler / Build Tool Versions** (if relevant):  
+
+---
+
+## Additional Context
+
+**Logs / Error Output**  
+<!-- Paste error messages, stack traces, or build logs -->
+
+**Screenshots/Screencasts (if applicable)**  
+<!-- Add images or videos to help explain the problem -->
+
+**Workarounds Tried (optional)**  
+<!-- Any temporary fixes you found? -->
@@ -0,0 +1,65 @@
+---
+name: ✨ Feature Request
+about: Suggest a new feature or improvement for the project
+title: "[feature]: "
+labels: enhancement
+assignees: ""
+---
+
+<!-- 💡 **Please fill out the information below. Incomplete requests may be closed or moved to Discussions.** 💡 -->
+
+### Checklist
+
+- [ ] I have searched existing issues and discussions to ensure this feature hasn’t been suggested yet.  
+- [ ] I have clearly described the problem this feature would solve.  
+- [ ] I have outlined how this feature would improve the project for users or developers.  
+- [ ] I have filled out all the information below.
+
+## Summary
+
+**Feature Type**  
+
+- [ ] 🚀 End-user functionality  
+- [ ] 📦 Integration / New API  
+- [ ] 🎨 UI/UX improvement  
+- [ ] ⚡ Performance optimization  
+- [ ] 🧠 Developer experience improvement  
+- [ ] 🤔 Other (please specify):
+
+**Problem / Motivation**  
+<!-- What problem does this feature solve? Why is it needed? -->
+
+**Proposed Solution / Feature Description**  
+<!-- Describe your idea in detail. Include how it might work, appear, or behave. -->
+
+**Alternatives Considered**  
+<!-- What other approaches did you try or think about? Why aren’t they sufficient? -->
+
+---
+
+## Impact and Scope
+
+**Who Benefits**  
+<!-- Which users, teams, or use cases will this feature help? -->
+
+**Possible Risks or Tradeoffs**  
+<!-- Are there potential downsides, maintenance costs, or compatibility issues? -->
+
+**Priority Level**  
+
+- [ ] 💚 Nice-to-have  
+- [ ] 💖 Important  
+- [ ] 🔥 Critical / Blocking  
+
+---
+
+## Additional Context
+
+**Related Issues / PRs**  
+<!-- Link to related issues or pull requests if any -->
+
+**Mockups / Diagrams / Examples (optional)**  
+<!-- Add visuals, sketches, or example code to clarify your idea -->
+
+**Notes or References (optional)**  
+<!-- Links, research, or external references that support your proposal -->
@@ -0,0 +1,70 @@
+---
+name: 😓 QA Issue
+about: Report a QA issue you've encountered
+title: "[qa]: "
+labels: qa
+assignees: ""
+---
+
+<!-- 🛑 **Please fill out the information below. Issues missing the required information will be automatically closed** 🛑 -->
+
+### Checklist
+
+- [ ] I have searched existing issues to ensure this hasn’t been reported yet.  
+- [ ] I have provided enough information for others to identify the issue.
+- [ ] I have encountered this issue at least twice
+- [ ] I have filled out all the information below
+
+> ⚠️ Please do not open an issue if you've encountered the undesired behavior only once.
+> Document your findings and include them in an issue when you can encounter the issue at least a second time
+
+## Description
+
+**Type**  
+
+- [ ] 🔍 Analyzer/Lint/Tidy
+- [ ] 📏 Formatting
+- [ ] 🎨 Code style
+- [ ] 🛠️ Build issue
+- [ ] 📚 Documentation
+- [ ] 🧪 Test failure/coverage
+- [ ] 🔄 CI/CD
+- [ ] ⚡ Performance (CPU/GPU/Memory usage, latency, etc.)
+- [ ] 📦 Installation/Setup
+- [ ] 🔌 API
+- [ ] 🤔 Other (please specify):
+
+**Encountered Behavior**  
+<!-- What happened? -->
+
+**Expected Behavior**  
+<!-- What should have happened instead? -->
+
+**Steps/Code Snippet to Reproduce**  
+<!-- Provide minimal, self-contained code or exact steps -->
+
+**Version tag / Git commit**  
+<!-- Paste the output of `git rev-parse HEAD` -->
+
+---
+
+## System Specs (if applicable)
+<!-- If not applicable, delete the list below and write "N/A" -->
+
+- **CPU** (model + architecture):  
+- **GPU** (model + driver version):
+- **Operating System & Version**:  
+- **Compiler / Build Tool Versions** (if relevant):  
+
+---
+
+## Additional Context
+
+**Logs / Error Output**  
+<!-- Paste error messages, stack traces, or build logs -->
+
+**Screenshots/Screencasts (if applicable)**  
+<!-- Add images or videos to help explain the problem -->
+
+**Workarounds Tried (optional)**  
+<!-- Any temporary fixes you found? -->