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
118 changes: 118 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -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 report a bug! Please fill out the sections below.

- type: input
id: version
attributes:
label: Ticketr Version
description: Output of `ticketr --version`
placeholder: "v0.2.0"
validations:
required: true

- type: dropdown
id: os
attributes:
label: Operating System
options:
- Linux
- macOS
- Windows
- Docker
- Other
validations:
required: true

- type: input
id: go-version
attributes:
label: Go Version
description: Output of `go version` (if building from source)
placeholder: "go1.22.0"
validations:
required: false

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

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

- type: textarea
id: steps
attributes:
label: Steps to Reproduce
description: Detailed steps to reproduce the issue
placeholder: |
1. Run command `ticketr push tickets.md`
2. See error...
validations:
required: true

- type: textarea
id: logs
attributes:
label: Relevant Logs
description: |
Logs from `.ticketr/logs/` directory.
**Important:** Review logs to ensure no sensitive data (API tokens) is included.
placeholder: Paste relevant log output here
render: shell
validations:
required: false

- type: textarea
id: config
attributes:
label: Configuration
description: |
Relevant parts of your configuration (`.ticketr.yaml`, environment variables).
**Important:** Do NOT include API tokens or credentials!
placeholder: |
JIRA_URL=https://mycompany.atlassian.net
JIRA_PROJECT_KEY=PROJ
render: yaml
validations:
required: false

- type: textarea
id: additional
attributes:
label: Additional Context
description: Any other context, screenshots, or information
placeholder: Add any other context about the problem here
validations:
required: false

- type: checkboxes
id: checklist
attributes:
label: Pre-submission Checklist
options:
- label: I have searched for similar issues
required: true
- label: I have reviewed the [documentation](https://github.com/karolswdev/ticktr/tree/main/docs)
required: true
- label: I have checked that logs contain no sensitive data
required: true
- label: I am using the latest version of Ticketr
required: false
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: true
contact_links:
- name: Question or Discussion
url: https://github.com/karolswdev/ticktr/discussions
about: Ask questions, share tips, or discuss ideas with the community
- name: Security Vulnerability
url: https://github.com/karolswdev/ticktr/blob/main/SECURITY.md
about: Report security vulnerabilities privately (DO NOT open a public issue)
- name: Documentation
url: https://github.com/karolswdev/ticktr/tree/main/docs
about: Read the comprehensive documentation
- name: Support
url: https://github.com/karolswdev/ticktr/blob/main/SUPPORT.md
about: Get help and support information
97 changes: 97 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
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 provide detailed information below.

- type: textarea
id: problem
attributes:
label: Problem Statement
description: What problem does this feature solve?
placeholder: "As a [user type], I have trouble with [problem]..."
validations:
required: true

- type: textarea
id: solution
attributes:
label: Proposed Solution
description: How would you like this feature to work?
placeholder: Describe your ideal solution
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: Alternatives Considered
description: Have you considered any alternative solutions or workarounds?
placeholder: Describe alternatives you've considered
validations:
required: false

- type: dropdown
id: impact
attributes:
label: Who Would Benefit?
description: Who would find this feature useful?
multiple: true
options:
- Individual developers
- Small teams (2-10)
- Large teams (10+)
- CI/CD automation
- Enterprise users
- Open source projects
validations:
required: true

- type: dropdown
id: priority
attributes:
label: Priority (Your Perspective)
description: How important is this feature to you?
options:
- Critical - Blocking my workflow
- High - Would significantly improve my workflow
- Medium - Nice to have
- Low - Minor improvement
validations:
required: true

- type: textarea
id: examples
attributes:
label: Example Use Cases
description: Provide concrete examples of how you'd use this feature
placeholder: |
1. When working on sprint planning...
2. During code review...
validations:
required: false

- type: textarea
id: additional
attributes:
label: Additional Context
description: Any other context, mockups, or references
placeholder: Links to similar features in other tools, mockups, etc.
validations:
required: false

- type: checkboxes
id: checklist
attributes:
label: Pre-submission Checklist
options:
- label: I have searched for similar feature requests
required: true
- label: I have reviewed the [ROADMAP](https://github.com/karolswdev/ticktr/blob/main/ROADMAP.md)
required: true
- label: I am willing to contribute this feature (if possible)
required: false
82 changes: 82 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
## Description

<!-- Briefly describe what this PR does -->

## Type of Change

<!-- Check all that apply -->

- [ ] Bug fix (non-breaking change that fixes an issue)
- [ ] New feature (non-breaking change that adds functionality)
- [ ] Breaking change (fix or feature that causes existing functionality to change)
- [ ] Documentation update
- [ ] Refactoring (no functional changes)
- [ ] Performance improvement
- [ ] Test coverage improvement

## Related Issues

<!-- Link to related issues: Fixes #123, Relates to #456 -->

## Changes Made

<!-- List the key changes in this PR -->

-
-
-

## Testing

<!-- Describe the testing you've done -->

- [ ] All existing tests pass (`go test ./...`)
- [ ] Added new tests for new functionality
- [ ] Tested manually with the following scenarios:
-
- [ ] Updated documentation (if applicable)

### Test Coverage

<!-- If you added/changed code, what's the test coverage? -->

```bash
# Paste output of: go test ./... -coverprofile=coverage.out && go tool cover -func=coverage.out | tail -1
```

## Documentation

<!-- Check all that apply -->

- [ ] Updated README.md (if user-facing changes)
- [ ] Updated relevant docs in `docs/` directory
- [ ] Added/updated code comments
- [ ] Updated CHANGELOG.md
- [ ] Updated examples (if applicable)

## Checklist

<!-- All items must be checked before merging -->

- [ ] My code follows the project's style guide
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] My changes generate no new warnings
- [ ] I have run `go fmt` and `go vet`
- [ ] I have run `staticcheck ./...` with no errors
- [ ] Any dependent changes have been merged and published

## Screenshots (if applicable)

<!-- Add screenshots for UI changes or console output -->

## Additional Notes

<!-- Any additional information reviewers should know -->

---

**By submitting this PR, I confirm that:**
- My contribution is made under the project's MIT license
- I have read and agree to the [Code of Conduct](../CODE_OF_CONDUCT.md)
- I have followed the [Contributing Guidelines](../CONTRIBUTING.md)
6 changes: 3 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Added
- **Milestone 12**: Requirements consolidation and documentation governance
- ARCHITECTURE.md with comprehensive system architecture
- docs/ARCHITECTURE.md with comprehensive system architecture
- docs/style-guide.md for documentation standards
- Legacy v1 requirements archived to docs/legacy/
- Phase playbooks archived to docs/history/
Expand All @@ -33,7 +33,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- docs/WORKFLOW.md with end-to-end walkthrough (379 lines)
- CONTRIBUTING.md with testing and architecture guidelines
- README Quick Reference section
- Enhanced requirement traceability in REQUIREMENTS-v2.md
- Enhanced requirement traceability in docs/development/REQUIREMENTS.md

### Changed
- All documentation cross-references established
Expand Down Expand Up @@ -160,7 +160,7 @@ During pre-1.0 development:
### Version 1.0.0 Criteria

Version 1.0.0 will be released when:
- All items in ROADMAP.md Milestone 13 are complete
- All items in docs/development/ROADMAP.md Milestone 13 are complete
- Production-ready security practices implemented
- Stable public API established
- Comprehensive test coverage (>70%)
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ internal/
- Services orchestrate domain operations
- Tests mock ports for isolation

For comprehensive architecture documentation including data flows, design decisions, and component details, see [ARCHITECTURE.md](ARCHITECTURE.md).
For comprehensive architecture documentation including data flows, design decisions, and component details, see [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md).

## Testing Guidelines

Expand Down
Loading
Loading