Skip to content
Merged
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
2 changes: 1 addition & 1 deletion .config/pyproject_template/settings.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description = "A MUD proxy with plugin support for Python 3.12+"
author_name = "Bast"
author_email = "bast@bastproxy.com"
github_user = "endavis"
github_repo = "bastproxy-py3"
github_repo = "bastproxy"

[template]
commit = "2c1171b97183a76fe8415d408432bf344081507c"
Expand Down
45 changes: 0 additions & 45 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

80 changes: 80 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
name: 🐛 Bug Report
description: Report a bug or unexpected behavior
labels: ["bug", "needs-triage"]
body:
- type: markdown
attributes:
value: |
## Report a Bug

Help us fix the issue by providing clear reproduction steps.

- type: textarea
id: bug-description
attributes:
label: Bug Description
description: A clear and concise description of what the bug is
placeholder: |
Describe the bug and its impact.
Example: "Application crashes when processing files larger than 10MB..."
validations:
required: true

- type: textarea
id: steps-to-reproduce
attributes:
label: Steps to Reproduce
description: Step-by-step instructions to reproduce the issue
placeholder: |
1. Run command `...`
2. With input `...`
3. Observe error `...`
validations:
required: true

- type: textarea
id: expected-vs-actual
attributes:
label: Expected vs Actual Behavior
description: What should happen vs what actually happens
placeholder: |
**Expected:** The function should return a valid result
**Actual:** The function raises ValueError
validations:
required: true

- type: textarea
id: environment
attributes:
label: Environment
description: System information (Python version, OS, package version)
placeholder: |
- Python: 3.12
- OS: Ubuntu 22.04
- Package version: 1.2.3
render: markdown
validations:
required: false

- type: textarea
id: error-output
attributes:
label: Error Output
description: Paste any error messages, stack traces, or relevant logs
placeholder: Paste error output here...
render: shell
validations:
required: false

- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Any other relevant information
placeholder: |
- Screenshots
- Related issues
- Workarounds attempted
- Possible solutions
validations:
required: false
72 changes: 72 additions & 0 deletions .github/ISSUE_TEMPLATE/chore.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
name: 🔨 Chore / Maintenance
description: Maintenance tasks, tooling, CI/CD, or dependency updates
labels: ["chore", "needs-triage"]
body:
- type: markdown
attributes:
value: |
## Chore / Maintenance Task

Describe the maintenance or tooling task that needs to be done.

- type: dropdown
id: chore-type
attributes:
label: Chore Type
description: What kind of maintenance task is this?
options:
- CI/CD configuration
- Dependency updates
- Tooling improvements
- Code cleanup
- Configuration changes
- Other
validations:
required: true

- type: textarea
id: description
attributes:
label: Description
description: Describe the maintenance task
placeholder: |
What needs to be done and why?
Example: "Update GitHub Actions to use Node 20 before Node 16 EOL..."
validations:
required: true

- type: textarea
id: proposed-changes
attributes:
label: Proposed Changes
description: What specific changes need to be made?
placeholder: |
- Update file X
- Modify configuration Y
- Add/remove dependency Z
validations:
required: false

- type: textarea
id: success-criteria
attributes:
label: Success Criteria
description: How will we know this task is complete?
placeholder: |
- [ ] CI passes
- [ ] No breaking changes
- [ ] Documentation updated if needed
validations:
required: false

- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Any other relevant information
placeholder: |
- Related issues
- Urgency/timeline
- Dependencies on other tasks
validations:
required: false
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: 💬 Discussions
url: https://github.com/{owner}/{repo}/discussions
about: For questions, ideas, and general discussions
- name: 📖 Documentation
url: https://github.com/{owner}/{repo}/blob/main/README.md
about: Check the documentation for usage guides and examples
74 changes: 74 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
name: 📚 Documentation Request
description: Request new documentation or improvements to existing docs
labels: ["documentation", "needs-triage"]
body:
- type: markdown
attributes:
value: |
## Documentation Request

Help us improve our documentation by describing what's needed.

- type: dropdown
id: doc-type
attributes:
label: Documentation Type
description: What kind of documentation change is needed?
options:
- New guide or tutorial
- Update existing documentation
- Fix incorrect information
- Add code examples
- API documentation
- Other
validations:
required: true

- type: textarea
id: description
attributes:
label: Description
description: Describe the documentation that is needed
placeholder: |
What documentation is missing or needs improvement?
Example: "There's no guide explaining how to configure logging..."
validations:
required: true

- type: textarea
id: location
attributes:
label: Suggested Location
description: Where should this documentation live?
placeholder: |
- docs/getting-started/
- docs/examples/
- README.md
- Inline code comments
validations:
required: false

- type: textarea
id: success-criteria
attributes:
label: Success Criteria
description: How will we know the documentation is complete?
placeholder: |
- [ ] Topic is fully explained
- [ ] Code examples included
- [ ] Added to navigation/index
- [ ] Reviewed for accuracy
validations:
required: false

- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Any other relevant information
placeholder: |
- Links to related documentation
- Examples from other projects
- Target audience
validations:
required: false
44 changes: 0 additions & 44 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

58 changes: 58 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
name: ✨ Feature Request
description: Propose a new feature or enhancement
labels: ["enhancement", "needs-triage"]
body:
- type: markdown
attributes:
value: |
## Propose a New Feature

Describe the problem you're trying to solve and your proposed solution.

- type: textarea
id: problem
attributes:
label: Problem
description: What problem does this feature solve? What need does it address?
placeholder: |
Describe the problem or limitation you're experiencing.
Example: "Currently, there's no way to validate custom data types..."
validations:
required: true

- type: textarea
id: proposed-solution
attributes:
label: Proposed Solution
description: Describe how you envision this feature working
placeholder: |
Clear description of what you want to happen.
Include specific implementation ideas if you have them.
validations:
required: true

- type: textarea
id: success-criteria
attributes:
label: Success Criteria
description: How will we know this feature is complete and working correctly?
placeholder: |
- [ ] Feature implements X functionality
- [ ] Tests added and passing
- [ ] Documentation updated
- [ ] Works with existing code without breaking changes
validations:
required: false

- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Add any other context, examples, links, or screenshots
placeholder: |
- Similar features in other projects
- Code examples
- Use cases
- Breaking change considerations
validations:
required: false
Loading
Loading