Skip to content

Commit ac53a06

Browse files
karolswdevkarolswdev
authored
Merge pull request #15 from karolswdev/release/v1.0.0-public-release
Release v1.0.0 - First Public Release 🚀
2 parents ba0608c + 53b67d2 commit ac53a06

21 files changed

+1950
-757
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
name: Bug Report
2+
description: Report a bug or unexpected behavior
3+
title: "[Bug]: "
4+
labels: ["bug", "triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to report a bug! Please fill out the sections below.
10+
11+
- type: input
12+
id: version
13+
attributes:
14+
label: Ticketr Version
15+
description: Output of `ticketr --version`
16+
placeholder: "v0.2.0"
17+
validations:
18+
required: true
19+
20+
- type: dropdown
21+
id: os
22+
attributes:
23+
label: Operating System
24+
options:
25+
- Linux
26+
- macOS
27+
- Windows
28+
- Docker
29+
- Other
30+
validations:
31+
required: true
32+
33+
- type: input
34+
id: go-version
35+
attributes:
36+
label: Go Version
37+
description: Output of `go version` (if building from source)
38+
placeholder: "go1.22.0"
39+
validations:
40+
required: false
41+
42+
- type: textarea
43+
id: description
44+
attributes:
45+
label: Bug Description
46+
description: A clear description of the bug
47+
placeholder: What happened?
48+
validations:
49+
required: true
50+
51+
- type: textarea
52+
id: expected
53+
attributes:
54+
label: Expected Behavior
55+
description: What did you expect to happen?
56+
placeholder: Describe the expected behavior
57+
validations:
58+
required: true
59+
60+
- type: textarea
61+
id: steps
62+
attributes:
63+
label: Steps to Reproduce
64+
description: Detailed steps to reproduce the issue
65+
placeholder: |
66+
1. Run command `ticketr push tickets.md`
67+
2. See error...
68+
validations:
69+
required: true
70+
71+
- type: textarea
72+
id: logs
73+
attributes:
74+
label: Relevant Logs
75+
description: |
76+
Logs from `.ticketr/logs/` directory.
77+
**Important:** Review logs to ensure no sensitive data (API tokens) is included.
78+
placeholder: Paste relevant log output here
79+
render: shell
80+
validations:
81+
required: false
82+
83+
- type: textarea
84+
id: config
85+
attributes:
86+
label: Configuration
87+
description: |
88+
Relevant parts of your configuration (`.ticketr.yaml`, environment variables).
89+
**Important:** Do NOT include API tokens or credentials!
90+
placeholder: |
91+
JIRA_URL=https://mycompany.atlassian.net
92+
JIRA_PROJECT_KEY=PROJ
93+
render: yaml
94+
validations:
95+
required: false
96+
97+
- type: textarea
98+
id: additional
99+
attributes:
100+
label: Additional Context
101+
description: Any other context, screenshots, or information
102+
placeholder: Add any other context about the problem here
103+
validations:
104+
required: false
105+
106+
- type: checkboxes
107+
id: checklist
108+
attributes:
109+
label: Pre-submission Checklist
110+
options:
111+
- label: I have searched for similar issues
112+
required: true
113+
- label: I have reviewed the [documentation](https://github.com/karolswdev/ticktr/tree/main/docs)
114+
required: true
115+
- label: I have checked that logs contain no sensitive data
116+
required: true
117+
- label: I am using the latest version of Ticketr
118+
required: false

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: Question or Discussion
4+
url: https://github.com/karolswdev/ticktr/discussions
5+
about: Ask questions, share tips, or discuss ideas with the community
6+
- name: Security Vulnerability
7+
url: https://github.com/karolswdev/ticktr/blob/main/SECURITY.md
8+
about: Report security vulnerabilities privately (DO NOT open a public issue)
9+
- name: Documentation
10+
url: https://github.com/karolswdev/ticktr/tree/main/docs
11+
about: Read the comprehensive documentation
12+
- name: Support
13+
url: https://github.com/karolswdev/ticktr/blob/main/SUPPORT.md
14+
about: Get help and support information

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
name: Feature Request
2+
description: Suggest a new feature or enhancement
3+
title: "[Feature]: "
4+
labels: ["enhancement"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for suggesting a feature! Please provide detailed information below.
10+
11+
- type: textarea
12+
id: problem
13+
attributes:
14+
label: Problem Statement
15+
description: What problem does this feature solve?
16+
placeholder: "As a [user type], I have trouble with [problem]..."
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: solution
22+
attributes:
23+
label: Proposed Solution
24+
description: How would you like this feature to work?
25+
placeholder: Describe your ideal solution
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: alternatives
31+
attributes:
32+
label: Alternatives Considered
33+
description: Have you considered any alternative solutions or workarounds?
34+
placeholder: Describe alternatives you've considered
35+
validations:
36+
required: false
37+
38+
- type: dropdown
39+
id: impact
40+
attributes:
41+
label: Who Would Benefit?
42+
description: Who would find this feature useful?
43+
multiple: true
44+
options:
45+
- Individual developers
46+
- Small teams (2-10)
47+
- Large teams (10+)
48+
- CI/CD automation
49+
- Enterprise users
50+
- Open source projects
51+
validations:
52+
required: true
53+
54+
- type: dropdown
55+
id: priority
56+
attributes:
57+
label: Priority (Your Perspective)
58+
description: How important is this feature to you?
59+
options:
60+
- Critical - Blocking my workflow
61+
- High - Would significantly improve my workflow
62+
- Medium - Nice to have
63+
- Low - Minor improvement
64+
validations:
65+
required: true
66+
67+
- type: textarea
68+
id: examples
69+
attributes:
70+
label: Example Use Cases
71+
description: Provide concrete examples of how you'd use this feature
72+
placeholder: |
73+
1. When working on sprint planning...
74+
2. During code review...
75+
validations:
76+
required: false
77+
78+
- type: textarea
79+
id: additional
80+
attributes:
81+
label: Additional Context
82+
description: Any other context, mockups, or references
83+
placeholder: Links to similar features in other tools, mockups, etc.
84+
validations:
85+
required: false
86+
87+
- type: checkboxes
88+
id: checklist
89+
attributes:
90+
label: Pre-submission Checklist
91+
options:
92+
- label: I have searched for similar feature requests
93+
required: true
94+
- label: I have reviewed the [ROADMAP](https://github.com/karolswdev/ticktr/blob/main/ROADMAP.md)
95+
required: true
96+
- label: I am willing to contribute this feature (if possible)
97+
required: false

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
## Description
2+
3+
<!-- Briefly describe what this PR does -->
4+
5+
## Type of Change
6+
7+
<!-- Check all that apply -->
8+
9+
- [ ] Bug fix (non-breaking change that fixes an issue)
10+
- [ ] New feature (non-breaking change that adds functionality)
11+
- [ ] Breaking change (fix or feature that causes existing functionality to change)
12+
- [ ] Documentation update
13+
- [ ] Refactoring (no functional changes)
14+
- [ ] Performance improvement
15+
- [ ] Test coverage improvement
16+
17+
## Related Issues
18+
19+
<!-- Link to related issues: Fixes #123, Relates to #456 -->
20+
21+
## Changes Made
22+
23+
<!-- List the key changes in this PR -->
24+
25+
-
26+
-
27+
-
28+
29+
## Testing
30+
31+
<!-- Describe the testing you've done -->
32+
33+
- [ ] All existing tests pass (`go test ./...`)
34+
- [ ] Added new tests for new functionality
35+
- [ ] Tested manually with the following scenarios:
36+
-
37+
- [ ] Updated documentation (if applicable)
38+
39+
### Test Coverage
40+
41+
<!-- If you added/changed code, what's the test coverage? -->
42+
43+
```bash
44+
# Paste output of: go test ./... -coverprofile=coverage.out && go tool cover -func=coverage.out | tail -1
45+
```
46+
47+
## Documentation
48+
49+
<!-- Check all that apply -->
50+
51+
- [ ] Updated README.md (if user-facing changes)
52+
- [ ] Updated relevant docs in `docs/` directory
53+
- [ ] Added/updated code comments
54+
- [ ] Updated CHANGELOG.md
55+
- [ ] Updated examples (if applicable)
56+
57+
## Checklist
58+
59+
<!-- All items must be checked before merging -->
60+
61+
- [ ] My code follows the project's style guide
62+
- [ ] I have performed a self-review of my own code
63+
- [ ] I have commented my code, particularly in hard-to-understand areas
64+
- [ ] My changes generate no new warnings
65+
- [ ] I have run `go fmt` and `go vet`
66+
- [ ] I have run `staticcheck ./...` with no errors
67+
- [ ] Any dependent changes have been merged and published
68+
69+
## Screenshots (if applicable)
70+
71+
<!-- Add screenshots for UI changes or console output -->
72+
73+
## Additional Notes
74+
75+
<!-- Any additional information reviewers should know -->
76+
77+
---
78+
79+
**By submitting this PR, I confirm that:**
80+
- My contribution is made under the project's MIT license
81+
- I have read and agree to the [Code of Conduct](../CODE_OF_CONDUCT.md)
82+
- I have followed the [Contributing Guidelines](../CONTRIBUTING.md)

‎CHANGELOG.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1919

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

3838
### Changed
3939
- All documentation cross-references established
@@ -160,7 +160,7 @@ During pre-1.0 development:
160160
### Version 1.0.0 Criteria
161161

162162
Version 1.0.0 will be released when:
163-
- All items in ROADMAP.md Milestone 13 are complete
163+
- All items in docs/development/ROADMAP.md Milestone 13 are complete
164164
- Production-ready security practices implemented
165165
- Stable public API established
166166
- Comprehensive test coverage (>70%)

‎CONTRIBUTING.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ internal/
6262
- Services orchestrate domain operations
6363
- Tests mock ports for isolation
6464

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

6767
## Testing Guidelines
6868

0 commit comments

Comments
 (0)