chore: add coc, contibution, and security documents for community guidelines

This commit is contained in:
Karol Broda
2026-01-01 20:53:47 +01:00
parent df15770a94
commit c7ead89f69
7 changed files with 546 additions and 0 deletions

118
.github/ISSUE_TEMPLATE/bug_report.yml vendored Normal file
View File

@@ -0,0 +1,118 @@
name: Bug Report
description: Report a bug or unexpected behavior
title: "[bug]: "
labels: ["bug", "triage"]
body:
- type: markdown
attributes:
value: |
thanks for taking the time to fill out this bug report!
please provide as much detail as possible to help us investigate.
- type: textarea
id: description
attributes:
label: Description
description: A clear description of what the bug is.
placeholder: What happened? What did you expect to happen?
validations:
required: true
- type: textarea
id: reproduce
attributes:
label: Steps to Reproduce
description: How can we reproduce this issue?
placeholder: |
1. run `snitch ...`
2. press '...'
3. see error
validations:
required: true
- type: textarea
id: expected
attributes:
label: Expected Behavior
description: What did you expect to happen?
validations:
required: false
- type: textarea
id: actual
attributes:
label: Actual Behavior
description: What actually happened? Include any error messages.
validations:
required: false
- type: input
id: version
attributes:
label: Version
description: What version of snitch are you running? (`snitch version`)
placeholder: "v0.1.0"
validations:
required: true
- type: dropdown
id: os
attributes:
label: Operating System
options:
- Linux
- macOS
- Other
validations:
required: true
- type: input
id: os-version
attributes:
label: OS Version
description: e.g., Ubuntu 22.04, macOS 14.1, Arch Linux
placeholder: "Ubuntu 22.04"
validations:
required: false
- type: dropdown
id: install-method
attributes:
label: Installation Method
options:
- Homebrew
- go install
- Nix/NixOS
- AUR
- Binary download
- Install script
- Other
validations:
required: false
- type: textarea
id: config
attributes:
label: Configuration
description: Paste your `~/.config/snitch/snitch.toml` if relevant (optional)
render: toml
validations:
required: false
- type: textarea
id: logs
attributes:
label: Logs / Terminal Output
description: Paste any relevant terminal output or error messages
render: text
validations:
required: false
- type: textarea
id: additional
attributes:
label: Additional Context
description: Any other context about the problem? Screenshots, related issues, etc.
validations:
required: false

9
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View File

@@ -0,0 +1,9 @@
blank_issues_enabled: true
contact_links:
- name: Question / Discussion
url: https://github.com/karol-broda/snitch/discussions
about: Ask questions, share ideas, or discuss snitch usage
- name: Documentation
url: https://github.com/karol-broda/snitch#readme
about: Check the README for usage and configuration docs

View File

@@ -0,0 +1,69 @@
name: Feature Request
description: Suggest a new feature or enhancement
title: "[feature]: "
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
thanks for suggesting a feature! please describe your idea clearly.
- type: textarea
id: problem
attributes:
label: Problem / Use Case
description: What problem does this solve? What are you trying to accomplish?
placeholder: I'm always frustrated when...
validations:
required: true
- type: textarea
id: solution
attributes:
label: Proposed Solution
description: Describe your proposed solution or feature
placeholder: I would like snitch to...
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Alternatives Considered
description: Have you considered any alternative solutions or workarounds?
validations:
required: false
- type: dropdown
id: area
attributes:
label: Area
description: What part of snitch does this affect?
options:
- TUI (interactive mode)
- CLI output (ls, json, watch)
- Filtering / Sorting
- DNS resolution
- Configuration
- Installation / Packaging
- Documentation
- Other
validations:
required: false
- type: textarea
id: additional
attributes:
label: Additional Context
description: Any other context, mockups, or screenshots about the feature request
validations:
required: false
- type: checkboxes
id: contribution
attributes:
label: Contribution
description: Would you be interested in contributing this feature?
options:
- label: I'd be willing to submit a PR for this feature

39
.github/PULL_REQUEST_TEMPLATE.md vendored Normal file
View File

@@ -0,0 +1,39 @@
## Description
<!-- describe what this PR does -->
## Related Issues
<!-- link any related issues: fixes #123, closes #456 -->
## Type of Change
- [ ] bug fix
- [ ] new feature
- [ ] breaking change
- [ ] documentation
- [ ] refactoring
- [ ] other: <!-- describe -->
## AI Disclosure
<!-- required: select one -->
- [ ] `ai: none` — no ai assistance used
- [ ] `ai: assisted` — ai helped with portions (describe below)
- [ ] `ai: generated` — significant portions were ai-generated (describe below)
<!-- if ai-assisted or ai-generated, briefly describe what was ai-generated: -->
## Checklist
- [ ] i have tested these changes locally
- [ ] i have run `make test` and all tests pass
- [ ] i have run `make lint` and fixed any issues
- [ ] i have updated documentation if needed
- [ ] my code follows the existing style of the project
## Screenshots / Terminal Output
<!-- if applicable, add screenshots or terminal output showing the change -->