Skip to content

Commit ff4dd71

Browse files
rolfedhclaude
rolfedh
and
claude
committed
feat: Complete user documentation and technical debt improvements
## Documentation - Added comprehensive Quick Start Guide with troubleshooting section - Created example AsciiDoc files demonstrating all 27 rules - Prepared professional announcement blog post for release - Enhanced README with emojis, clear sections, and future roadmap ## GitHub Issue Templates - Added bug report template with structured fields - Created feature request template with use cases - Added user feedback template for migration experiences - Configured issue template settings with help links ## Technical Improvements - Fixed duplicate dependencies in CLAUDE.md auto-generation - Added dynamic --version flag reading from pyproject.toml - Implemented --dry-run support for journey command - Enhanced progress indicators with time estimates and file counts ## Error Message Improvements - Better path validation errors with actionable guidance - Clear instructions when paths are not configured - Improved file validation for empty/corrupted files - User-friendly messages that explain how to fix issues All tests passing (126/126) with improved coverage. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 1eb90c7 commit ff4dd71

19 files changed

+1476
-100
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
1+
name: 🐛 Bug Report
2+
description: Report a bug or unexpected behavior in Aditi
3+
title: "[Bug]: "
4+
labels: ["bug", "needs-triage"]
5+
assignees: []
6+
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thank you for reporting a bug! Please provide as much detail as possible to help us reproduce and fix the issue.
12+
13+
- type: checkboxes
14+
id: checklist
15+
attributes:
16+
label: Pre-submission Checklist
17+
description: Please verify you've completed these steps before submitting
18+
options:
19+
- label: I have searched existing issues to avoid duplicates
20+
required: true
21+
- label: I have tried the latest version of Aditi
22+
required: true
23+
- label: I have read the [Quick Start Guide](https://github.com/rolfedh/aditi/blob/main/docs/QUICKSTART.md)
24+
required: true
25+
26+
- type: textarea
27+
id: description
28+
attributes:
29+
label: Bug Description
30+
description: A clear and concise description of what the bug is
31+
placeholder: "Describe what happened and what you expected to happen"
32+
validations:
33+
required: true
34+
35+
- type: textarea
36+
id: reproduction
37+
attributes:
38+
label: Steps to Reproduce
39+
description: Provide step-by-step instructions to reproduce the issue
40+
placeholder: |
41+
1. Run `aditi init`
42+
2. Execute `aditi check docs/`
43+
3. Observe error message...
44+
validations:
45+
required: true
46+
47+
- type: textarea
48+
id: expected
49+
attributes:
50+
label: Expected Behavior
51+
description: What should have happened instead?
52+
placeholder: "Describe the expected behavior"
53+
validations:
54+
required: true
55+
56+
- type: textarea
57+
id: actual
58+
attributes:
59+
label: Actual Behavior
60+
description: What actually happened? Include error messages, stack traces, etc.
61+
placeholder: "Describe what actually happened"
62+
validations:
63+
required: true
64+
65+
- type: dropdown
66+
id: command
67+
attributes:
68+
label: Which command is affected?
69+
description: Select the Aditi command where the bug occurs
70+
options:
71+
- aditi init
72+
- aditi check
73+
- aditi fix
74+
- aditi journey
75+
- aditi vale
76+
- Multiple commands
77+
- Other/Unknown
78+
validations:
79+
required: true
80+
81+
- type: textarea
82+
id: environment
83+
attributes:
84+
label: Environment Information
85+
description: Provide details about your system
86+
placeholder: |
87+
- OS: (e.g., Ubuntu 22.04, macOS 13.1, Windows 11 WSL2)
88+
- Python version: (e.g., 3.11.2)
89+
- Aditi version: (e.g., 1.0.0)
90+
- Container runtime: (Podman/Docker version)
91+
render: markdown
92+
validations:
93+
required: true
94+
95+
- type: textarea
96+
id: sample-files
97+
attributes:
98+
label: Sample AsciiDoc Files
99+
description: If relevant, provide minimal AsciiDoc content that triggers the bug
100+
placeholder: |
101+
```adoc
102+
= Sample Document
103+
104+
Content that triggers the issue...
105+
```
106+
render: adoc
107+
108+
- type: textarea
109+
id: logs
110+
attributes:
111+
label: Command Output / Logs
112+
description: Include relevant command output, error messages, or log files
113+
placeholder: |
114+
```
115+
$ aditi check docs/
116+
[Error output here]
117+
```
118+
render: shell
119+
120+
- type: textarea
121+
id: additional
122+
attributes:
123+
label: Additional Context
124+
description: Any other information that might be helpful
125+
placeholder: "Screenshots, workarounds you've tried, related issues, etc."

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 📚 Documentation & Quick Start
4+
url: https://rolfedh.github.io/aditi/
5+
about: Full documentation, examples, and troubleshooting guide
6+
- name: 💬 Discussions
7+
url: https://github.com/rolfedh/aditi/discussions
8+
about: Ask questions, share experiences, and discuss best practices
9+
- name: 🐛 Security Issues
10+
url: https://github.com/rolfedh/aditi/security/advisories/new
11+
about: Report security vulnerabilities privately

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
name: 🚀 Feature Request
2+
description: Suggest a new feature or enhancement for Aditi
3+
title: "[Feature]: "
4+
labels: ["enhancement", "needs-triage"]
5+
assignees: []
6+
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thank you for suggesting a feature! Please provide detailed information about your proposal.
12+
13+
- type: checkboxes
14+
id: checklist
15+
attributes:
16+
label: Pre-submission Checklist
17+
description: Please verify you've completed these steps
18+
options:
19+
- label: I have searched existing issues to avoid duplicates
20+
required: true
21+
- label: I have checked the roadmap and known limitations
22+
required: true
23+
- label: This is not a bug report (use bug report template instead)
24+
required: true
25+
26+
- type: textarea
27+
id: problem
28+
attributes:
29+
label: Problem Statement
30+
description: What problem does this feature solve? What's the current limitation?
31+
placeholder: "Describe the problem or limitation you're experiencing"
32+
validations:
33+
required: true
34+
35+
- type: textarea
36+
id: solution
37+
attributes:
38+
label: Proposed Solution
39+
description: What would you like to see implemented?
40+
placeholder: "Describe your ideal solution in detail"
41+
validations:
42+
required: true
43+
44+
- type: dropdown
45+
id: category
46+
attributes:
47+
label: Feature Category
48+
description: Which area does this feature relate to?
49+
options:
50+
- CLI Commands & Interface
51+
- Rule Processing & Analysis
52+
- Auto-fixing & Transformations
53+
- Configuration & Setup
54+
- Performance & Optimization
55+
- Documentation & Examples
56+
- Container & Dependencies
57+
- Reporting & Output
58+
- Integration (CI/CD, Git, etc.)
59+
- Other
60+
validations:
61+
required: true
62+
63+
- type: dropdown
64+
id: priority
65+
attributes:
66+
label: Priority Level
67+
description: How important is this feature to your workflow?
68+
options:
69+
- High - Blocking my current work
70+
- Medium - Would significantly improve my workflow
71+
- Low - Nice to have enhancement
72+
validations:
73+
required: true
74+
75+
- type: textarea
76+
id: use-cases
77+
attributes:
78+
label: Use Cases
79+
description: Provide specific examples of how this feature would be used
80+
placeholder: |
81+
Example scenarios:
82+
1. When working with large repositories...
83+
2. In CI/CD pipelines...
84+
3. For specific document types...
85+
validations:
86+
required: true
87+
88+
- type: textarea
89+
id: alternatives
90+
attributes:
91+
label: Alternatives Considered
92+
description: What other solutions or workarounds have you considered?
93+
placeholder: "Describe alternative approaches or current workarounds you use"
94+
95+
- type: textarea
96+
id: examples
97+
attributes:
98+
label: Example Implementation
99+
description: If you have ideas about how this could work, share them
100+
placeholder: |
101+
Command examples:
102+
```bash
103+
aditi check --output-format json
104+
aditi fix --custom-rule my-rule.yml
105+
```
106+
render: bash
107+
108+
- type: checkboxes
109+
id: contribution
110+
attributes:
111+
label: Contribution Interest
112+
description: Would you be interested in contributing to this feature?
113+
options:
114+
- label: I would be willing to submit a PR for this feature
115+
- label: I can help with testing the implementation
116+
- label: I can provide additional use cases or feedback
117+
- label: I prefer to wait for maintainer implementation
118+
119+
- type: textarea
120+
id: additional
121+
attributes:
122+
label: Additional Context
123+
description: Any other information that would help understand this feature request
124+
placeholder: "Screenshots, mockups, related tools, inspiration sources, etc."

0 commit comments

Comments
 (0)