Added templates to combat spam

Unfortunately we are getting so much spam that these are necessary
2026-05-24 18:35:06 -04:00 · 2026-02-05 05:46:12 +00:00
parent daa0dd3b76
commit 54561ac40a
4 changed files with 230 additions and 0 deletions
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,34 @@
+## What does this PR do?
+
+<!-- Explain clearly what this changes and why. Link to the related issue. -->
+
+Fixes #
+
+## Type of change
+
+- [ ] Bug fix
+- [ ] New feature
+- [ ] Refactor (no functional change)
+- [ ] Documentation update
+
+## Checklist
+
+- [ ] I have read [CONTRIBUTING.md](CONTRIBUTING.md)
+- [ ] I have tested these changes locally and they work
+- [ ] I can explain every line of code in this PR if asked
+- [ ] This PR does not contain AI-generated code that I haven't personally reviewed, understood, and tested
+- [ ] I have not added any unnecessary comments, logging, or dead code
+- [ ] My code follows the existing style and conventions of the project
+- [ ] I have updated documentation if applicable
+
+## How to test
+
+<!-- Steps for the maintainer to verify this works: -->
+
+1. 
+2. 
+3. 
+
+## Screenshots (if UI change)
+
+<!-- Drag and drop before/after screenshots here -->
--- a/.github/bug_report.yml
+++ b/.github/bug_report.yml
@@ -0,0 +1,113 @@
+name: 🐛 Bug Report
+description: Something isn't working as expected. Please provide enough detail that I can actually reproduce it.
+title: "Bug: "
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to report a bug. Please fill in **all** the required fields below.
+        Issues missing required information will be closed without comment.
+
+  - type: checkboxes
+    id: existing-issues
+    attributes:
+      label: Pre-flight checks
+      description: Please confirm the following before submitting.
+      options:
+        - label: I have searched existing issues and this hasn't been reported before
+          required: true
+        - label: I am running the latest version of FossFLOW
+          required: true
+        - label: I have read the README and checked if this is expected behaviour
+          required: true
+
+  - type: dropdown
+    id: deployment
+    attributes:
+      label: Deployment method
+      description: How are you running FossFLOW?
+      options:
+        - Docker (docker run)
+        - Docker Compose
+        - Built from source (npm run dev)
+        - Built from source (npm run build)
+        - Online demo
+      default: 0
+    validations:
+      required: true
+
+  - type: input
+    id: version
+    attributes:
+      label: FossFLOW version / Docker image tag
+      description: "e.g. latest, v1.2.0, commit hash"
+      placeholder: "latest"
+    validations:
+      required: true
+
+  - type: input
+    id: browser
+    attributes:
+      label: Browser and version
+      description: "e.g. Chrome 131, Firefox 134, Safari 18.2"
+      placeholder: "Chrome 131"
+    validations:
+      required: true
+
+  - type: input
+    id: os
+    attributes:
+      label: Operating system
+      placeholder: "e.g. macOS 15.2, Windows 11, Ubuntu 24.04"
+    validations:
+      required: true
+
+  - type: textarea
+    id: description
+    attributes:
+      label: What happened?
+      description: A clear description of the bug. What did you expect to happen vs what actually happened?
+      placeholder: |
+        Expected: ...
+        Actual: ...
+    validations:
+      required: true
+
+  - type: textarea
+    id: reproduce
+    attributes:
+      label: Steps to reproduce
+      description: Minimum steps to reproduce the issue. If I can't reproduce it, I can't fix it.
+      placeholder: |
+        1. Open FossFLOW
+        2. Click on '...'
+        3. Observe '...'
+    validations:
+      required: true
+
+  - type: textarea
+    id: screenshots
+    attributes:
+      label: Screenshots / screen recordings
+      description: If applicable, add screenshots or a screen recording. Drag and drop images here.
+    validations:
+      required: false
+
+  - type: textarea
+    id: logs
+    attributes:
+      label: Browser console output / Docker logs
+      description: Open browser DevTools (F12) → Console tab, or run `docker logs <container>`. Paste any errors here.
+      render: shell
+    validations:
+      required: false
+
+  - type: textarea
+    id: diagram-json
+    attributes:
+      label: Diagram JSON (if relevant)
+      description: Export your diagram and paste the JSON here if the bug is diagram-specific. Remove anything sensitive first.
+      render: json
+    validations:
+      required: false
--- a/.github/config.yml
+++ b/.github/config.yml
@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: 💬 General Discussion
+    url: https://github.com/stan-smith/FossFLOW/discussions
+    about: Got a question, idea, or just want to chat? Start a discussion instead of an issue.
+  - name: 📖 README & Documentation
+    url: https://github.com/stan-smith/FossFLOW#readme
+    about: Please check the docs before opening an issue - your answer might already be there.
--- a/.github/feature_request.yml
+++ b/.github/feature_request.yml
@@ -0,0 +1,75 @@
+name: 💡 Feature Request
+description: Suggest a new feature or improvement. Please check the project scope first.
+title: "Feature: "
+labels: ["enhancement"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for the suggestion! Before submitting, please understand that FossFLOW is a **simple, privacy-first diagramming tool**. 
+        
+        The following are **out of scope** and will be closed immediately:
+        - Authentication, RBAC, OIDC, or multi-tenancy
+        - User accounts or team management
+        - Cloud hosting or SaaS features
+        - Anything that fundamentally changes what FossFLOW is
+        
+        If you're unsure whether your idea fits, open a [Discussion](https://github.com/stan-smith/FossFLOW/discussions) first.
+
+  - type: checkboxes
+    id: preflight
+    attributes:
+      label: Pre-flight checks
+      options:
+        - label: I have searched existing issues and feature requests for duplicates
+          required: true
+        - label: This feature is within the scope described above
+          required: true
+        - label: I have checked [Discussions](https://github.com/stan-smith/FossFLOW/discussions) for related topics
+          required: true
+
+  - type: textarea
+    id: problem
+    attributes:
+      label: What problem does this solve?
+      description: Describe the problem or limitation you're experiencing. Focus on the *problem*, not the solution.
+      placeholder: "I'm trying to do X but currently I have to..."
+    validations:
+      required: true
+
+  - type: textarea
+    id: solution
+    attributes:
+      label: Proposed solution
+      description: How do you think this could be solved? Be specific.
+    validations:
+      required: true
+
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Alternatives you've considered
+      description: What other approaches have you tried or thought about?
+    validations:
+      required: true
+
+  - type: dropdown
+    id: contribution
+    attributes:
+      label: Are you willing to work on this?
+      description: Would you be prepared to submit a PR for this feature?
+      options:
+        - "Yes - I'd like to implement this myself"
+        - "Partially - I could help but would need guidance"
+        - "No - I'm suggesting it for someone else to build"
+      default: 2
+    validations:
+      required: true
+
+  - type: textarea
+    id: context
+    attributes:
+      label: Additional context
+      description: Screenshots, mockups, examples from other tools, etc.
+    validations:
+      required: false