Skip to content
Draft
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
13 changes: 13 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# These are supported funding model platforms

github: [] # Add GitHub Sponsors username(s)
patreon: # Add Patreon username
open_collective: # Add Open Collective project
ko_fi: # Add Ko-fi username
tidelift: # Add Tidelift package-manager/package-name
community_bridge: # Add Community Bridge project name
liberapay: # Add Liberapay username
issuehunt: # Add IssueHunt username
otechie: # Add Otechie username
lfx_crowdfunding: # Add LFX Crowdfunding project name
custom: [] # Add custom funding links
124 changes: 124 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
name: 🐛 Bug Report
description: Report a bug or unexpected behavior
title: "[Bug]: "
labels: ["bug", "triage"]
assignees: []

body:
- type: markdown
attributes:
value: |
Thanks for taking the time to report a bug! Please fill out the information below to help us resolve the issue.

- type: checkboxes
id: pre-check
attributes:
label: Pre-submission Checklist
options:
- label: I have searched existing issues to ensure this bug hasn't been reported
required: true
- label: I am using the latest version
required: true
- label: This is not a security vulnerability (use Security Policy instead)
required: true

- type: textarea
id: description
attributes:
label: Bug Description
description: A clear and concise description of the bug
placeholder: What went wrong?
validations:
required: true

- type: textarea
id: expected
attributes:
label: Expected Behavior
description: What should happen?
placeholder: Describe the expected behavior
validations:
required: true

- type: textarea
id: actual
attributes:
label: Actual Behavior
description: What actually happened?
placeholder: Describe what actually happened
validations:
required: true

- type: textarea
id: reproduction
attributes:
label: Steps to Reproduce
description: Step-by-step instructions to reproduce the bug
placeholder: |
1.
2.
3.
value: |
1.
2.
3.
validations:
required: true

- type: textarea
id: environment
attributes:
label: Environment
description: Provide details about your environment
value: |
- OS: [e.g., Ubuntu 22.04]
- Rust Version: [e.g., 1.75.0]
- Project Version: [e.g., 0.1.0]
- Kubernetes Version (if applicable): [e.g., 1.28]
validations:
required: true

- type: textarea
id: logs
attributes:
label: Relevant Logs/Errors
description: Paste any relevant logs or error messages
render: shell
placeholder: Paste logs here

- type: textarea
id: minimal-example
attributes:
label: Minimal Reproducible Example
description: If possible, provide a minimal code example that reproduces the issue
render: rust
placeholder: |
fn main() {
// Your code here
}

- type: dropdown
id: severity
attributes:
label: Severity
description: How severe is this bug?
options:
- Critical (system crash, data loss)
- High (major feature broken)
- Medium (feature partially broken)
- Low (minor issue, workaround available)
validations:
required: true

- type: textarea
id: additional
attributes:
label: Additional Context
description: Any other context, screenshots, or information about the bug

- type: checkboxes
id: volunteer
attributes:
label: Contribution
options:
- label: I would like to work on fixing this bug
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
blank_issues_enabled: false
contact_links:
- name: 💬 GitHub Discussions
url: https://github.com/orgs/guardyn/discussions
about: Ask questions and discuss ideas with the community
- name: 🔒 Security Vulnerability
url: https://github.com/guardyn/.github/blob/main/SECURITY.md
about: Report security vulnerabilities privately (DO NOT use public issues)
- name: 📖 Documentation
url: https://github.com/guardyn
about: Read the documentation
- name: 💼 Enterprise Support
url: mailto:enterprise@guardyn.io
about: Contact us for enterprise support options
93 changes: 93 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
name: 📚 Documentation Issue
description: Report an issue with documentation or suggest improvements
title: "[Docs]: "
labels: ["documentation", "triage"]
assignees: []

body:
- type: markdown
attributes:
value: |
Thanks for helping us improve our documentation!

- type: checkboxes
id: pre-check
attributes:
label: Pre-submission Checklist
options:
- label: I have searched existing issues
required: true

- type: dropdown
id: doc-type
attributes:
label: Documentation Type
description: What type of documentation is affected?
options:
- README
- API documentation
- Code comments
- Contributing guide
- Security policy
- Architecture documentation
- Tutorial/Guide
- Examples
- Other
validations:
required: true

- type: dropdown
id: issue-type
attributes:
label: Issue Type
description: What kind of documentation issue is this?
options:
- Error/Inaccuracy
- Missing documentation
- Unclear/Confusing
- Outdated
- Typo/Grammar
- Enhancement suggestion
validations:
required: true

- type: textarea
id: location
attributes:
label: Location
description: Where is the documentation issue?
placeholder: |
File: README.md
Section: Installation
Line: 42
validations:
required: true

- type: textarea
id: description
attributes:
label: Issue Description
description: What's wrong with the current documentation?
placeholder: Describe the issue
validations:
required: true

- type: textarea
id: suggestion
attributes:
label: Suggested Improvement
description: How should it be improved?
placeholder: Suggest better wording or additional content

- type: textarea
id: additional
attributes:
label: Additional Context
description: Any other relevant information

- type: checkboxes
id: volunteer
attributes:
label: Contribution
options:
- label: I would like to work on fixing this documentation issue
143 changes: 143 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,143 @@
name: ✨ Feature Request
description: Suggest a new feature or enhancement
title: "[Feature]: "
labels: ["enhancement", "triage"]
assignees: []

body:
- type: markdown
attributes:
value: |
Thanks for suggesting a new feature! Please provide as much detail as possible.

- type: checkboxes
id: pre-check
attributes:
label: Pre-submission Checklist
options:
- label: I have searched existing issues to ensure this feature hasn't been requested
required: true
- label: I have checked the project roadmap
required: true

- type: textarea
id: problem
attributes:
label: Problem Statement
description: What problem does this feature solve?
placeholder: Describe the problem or use case
validations:
required: true

- type: textarea
id: solution
attributes:
label: Proposed Solution
description: How should this feature work?
placeholder: Describe your proposed solution in detail
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: Alternatives Considered
description: What other solutions did you consider?
placeholder: Describe alternative solutions or workarounds

- type: dropdown
id: feature-type
attributes:
label: Feature Type
description: What type of feature is this?
options:
- New functionality
- Enhancement to existing feature
- Performance improvement
- Developer experience improvement
- Documentation improvement
- Security enhancement
- Other
validations:
required: true

- type: dropdown
id: priority
attributes:
label: Priority
description: How important is this feature?
options:
- Critical (blocking important use case)
- High (important for many users)
- Medium (nice to have)
- Low (minor enhancement)
validations:
required: true

- type: textarea
id: use-cases
attributes:
label: Use Cases
description: Describe specific use cases for this feature
placeholder: |
1. As a [user type], I want to [goal] so that [benefit]
2.
validations:
required: true

- type: textarea
id: impact
attributes:
label: Impact Assessment
description: Who benefits from this feature and how?
placeholder: |
- Users affected:
- Benefits:
- Potential drawbacks:

- type: textarea
id: technical-notes
attributes:
label: Technical Considerations
description: Any technical notes or implementation details to consider?
placeholder: Architecture, dependencies, breaking changes, etc.

- type: textarea
id: security-privacy
attributes:
label: Security and Privacy Impact
description: Any security or privacy implications?
placeholder: Describe any security or privacy considerations

- type: textarea
id: mockups
attributes:
label: Mockups/Examples
description: Provide mockups, diagrams, or code examples if applicable
placeholder: |
```rust
// Example API or usage
```

- type: checkboxes
id: requirements
attributes:
label: Requirements
options:
- label: This feature maintains E2EE guarantees
- label: This feature preserves user privacy
- label: This feature is backward compatible (or breaking changes are acceptable)
- label: This feature follows Rust best practices

- type: textarea
id: additional
attributes:
label: Additional Context
description: Any other context, screenshots, or links

- type: checkboxes
id: volunteer
attributes:
label: Contribution
options:
- label: I would like to work on implementing this feature
Loading