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
45 changes: 45 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,51 @@ body:
- Performance impact
- Workarounds you've tried

- type: dropdown
id: solution-interest
attributes:
label: Solution Interest
description: Are you interested in providing a solution for this bug?
options:
- "No, I just want to report the issue"
- "Yes, I can help fix this bug"
- "Maybe, I'd like to contribute but need guidance"
- "Not sure yet"
validations:
required: true

- type: dropdown
id: question-type
attributes:
label: Question Type
description: What kind of questions do you have about this issue?
multiple: true
options:
- "How does this affect my code?"
- "When will this be fixed?"
- "What are the workarounds?"
- "Can I help test the fix?"
- "I need clarification on the expected behavior"
- "Performance impact questions"
- "Compatibility questions"
- "Other questions"
validations:
required: false

- type: textarea
id: additional-questions
attributes:
label: Additional Questions
description: Any specific questions you have about this bug or its impact.
placeholder: |
- How does this affect my current implementation?
- Are there any immediate workarounds I can use?
- What should I expect in terms of timeline?
- Do you need any additional information from me?
- Any other questions or concerns?
validations:
required: false

- type: checkboxes
id: checklist
attributes:
Expand Down
44 changes: 44 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,50 @@ body:
- Screenshots of confusing sections
- Links to related documentation

- type: dropdown
id: contribution-interest
attributes:
label: Contribution Interest
description: Are you interested in helping fix this documentation issue?
options:
- "No, I just want to report the issue"
- "Yes, I can help fix this documentation"
- "Maybe, I'd like to contribute but need guidance"
- "Not sure yet"
validations:
required: true

- type: dropdown
id: question-type
attributes:
label: Question Type
description: What kind of questions do you have about this documentation issue?
multiple: true
options:
- "How should this be documented?"
- "What information is missing?"
- "When will this be fixed?"
- "Can I help improve the documentation?"
- "Clarity questions"
- "Accuracy questions"
- "Other questions"
validations:
required: false

- type: textarea
id: additional-questions
attributes:
label: Additional Questions
description: Any specific questions you have about this documentation issue.
placeholder: |
- What would be the best way to document this?
- Are there specific examples that would help?
- How does this relate to other documentation?
- Do you need any additional information from me?
- Any other questions or concerns?
validations:
required: false

- type: checkboxes
id: checklist
attributes:
Expand Down
44 changes: 44 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,50 @@ body:
- Performance requirements
- Compatibility considerations

- type: dropdown
id: implementation-interest
attributes:
label: Implementation Interest
description: Are you interested in implementing this feature yourself?
options:
- "No, I just want to suggest the feature"
- "Yes, I can implement this feature"
- "Maybe, I'd like to contribute but need guidance"
- "Not sure yet"
validations:
required: true

- type: dropdown
id: question-type
attributes:
label: Question Type
description: What kind of questions do you have about this feature?
multiple: true
options:
- "How would this feature work?"
- "What would the API look like?"
- "Timeline for implementation?"
- "Can I help design this feature?"
- "Technical feasibility questions"
- "Integration questions"
- "Other questions"
validations:
required: false

- type: textarea
id: additional-questions
attributes:
label: Additional Questions
description: Any specific questions you have about this feature request.
placeholder: |
- How would this integrate with existing functionality?
- Are there any technical constraints I'm not considering?
- What would be the migration path for existing users?
- Do you need any additional information from me?
- Any other questions or concerns?
validations:
required: false

- type: checkboxes
id: checklist
attributes:
Expand Down
45 changes: 45 additions & 0 deletions .github/ISSUE_TEMPLATE/help.yml
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,51 @@ body:
- Performance issues
- Environment details

- type: dropdown
id: solution-interest
attributes:
label: Solution Interest
description: Are you interested in providing a solution or just need help?
options:
- "I just need help/guidance"
- "I want to contribute a solution"
- "I might contribute but need guidance first"
- "Not sure yet"
validations:
required: true

- type: dropdown
id: question-type
attributes:
label: Question Type
description: What type of help do you need?
multiple: true
options:
- "How-to questions"
- "Troubleshooting help"
- "Best practices guidance"
- "API usage questions"
- "Configuration help"
- "Performance questions"
- "Integration questions"
- "Other questions"
validations:
required: false

- type: textarea
id: specific-questions
attributes:
label: Specific Questions
description: What are your specific questions or what help do you need?
placeholder: |
- What specific aspect are you struggling with?
- What have you tried that didn't work?
- What outcome are you hoping to achieve?
- Are there any constraints or requirements?
- Any other specific questions?
validations:
required: false

- type: checkboxes
id: checklist
attributes:
Expand Down
126 changes: 126 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/bug-fix-pr.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,126 @@
---
name: Bug Fix Pull Request
description: Submit a pull request for fixing a bug
title: "[BUGFIX] "
labels: ["bugfix", "triage"]
assignees: []
body:
- type: textarea
id: description
attributes:
label: Description
description: A clear and concise description of the bug fix.
placeholder: Describe the bug that was fixed and how this PR addresses it.
validations:
required: true

- type: input
id: issue-url
attributes:
label: Related Issue URL
description: Link to the GitHub issue this PR fixes
placeholder: https://github.com/muhammad-fiaz/logly/issues/ISSUE_NUMBER
validations:
required: true

- type: textarea
id: root-cause
attributes:
label: Root Cause
description: What was the root cause of the bug?
placeholder: Explain what caused the bug and why it occurred.
validations:
required: true

- type: textarea
id: solution
attributes:
label: Solution
description: How was the bug fixed?
placeholder: Describe the technical solution and implementation details.
validations:
required: true

- type: textarea
id: testing
attributes:
label: Testing
description: How was this fix tested?
placeholder: |
- Unit tests added/updated
- Integration tests
- Manual testing steps
- Test results
validations:
required: true

- type: input
id: version
attributes:
label: Logly Version
description: What version of Logly was this tested against?
placeholder: e.g., 0.1.4
validations:
required: true

- type: checkboxes
id: code-quality
attributes:
label: Code Quality Checklist
description: Please confirm the following
options:
- label: "cargo fmt has been run"
required: true
- label: "mypy passes with no errors"
required: true
- label: "pylint and clippy pass with no warnings"
required: true
- label: "cargo test and pytest pass"
required: true
- label: "uv run ruff format has been applied"
required: true
- label: "All new functions/classes have docstrings"
required: true
- label: "No unnecessary changes included"
required: true

- type: checkboxes
id: ai-usage
attributes:
label: AI Usage Disclosure
description: Please disclose AI tool usage
options:
- label: "I have used AI tools (GitHub Copilot, ChatGPT, etc.) to assist with this implementation"
- label: "No AI tools were used in this implementation"
validations:
required: true

- type: textarea
id: reviewers
attributes:
label: Reviewers
description: "@mention the person or team responsible for reviewing this PR"
placeholder: "@reviewer1 @reviewer2"
validations:
required: true

- type: textarea
id: breaking-changes
attributes:
label: Breaking Changes (if any)
description: Does this fix introduce any breaking changes?
placeholder: |
If yes, describe them and provide migration guidance:
- Breaking change 1
- Migration steps...

- type: textarea
id: additional-notes
attributes:
label: Additional Notes
description: Any additional information or context reviewers should be aware of.
placeholder: |
- Performance impact
- Security considerations
- Future improvements
- Related PRs
23 changes: 23 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Configuration for GitHub Pull Request Templates
# This file controls which pull request templates are available

# Disable blank PRs - users must use templates
blank_issues_enabled: false

# Contact links for additional support
contact_links:
- name: Logly Documentation
url: https://muhammad-fiaz.github.io/logly/
about: Check our documentation for help and guides

- name: Logly Community Discussions
url: https://github.com/muhammad-fiaz/logly/discussions
about: Join community discussions for questions and general chat

- name: Contributing Guide
url: https://github.com/muhammad-fiaz/logly/blob/main/CONTRIBUTING.md
about: Read our contributing guidelines for PR best practices

- name: Security Issues
url: https://github.com/muhammad-fiaz/logly/security/advisories/new
about: Report security vulnerabilities privately
Loading