Skip to content

Commit 32e4174

Browse files
Merge branch 'main' into support-django-6x
* main: chore(deps): bump node from 20-slim to 25-slim in /template (#34) feat(frontend): add Vite bundling option for HTMX+Tailwind (#32) fix(ci): add required copier fields to scheduled workflow (#33) chore(deps): bump actions/checkout from 5 to 6 (#30) chore: Update Issue/PR template (#29) feat(ecs): make deployment production-ready with monitoring (#28) feat: add complete Fly.io deployment implementation (#27) fix: Remove git config changes fix: remove unsafe _tasks section to eliminate copier trust warning feat: enhance copier template user experience (#22) chore: Modify CI triggers for pull requests docs: Clarify pytest coverage implies code coverage docs: Update link to GitHub discussions
2 parents af23d60 + 7bc8db3 commit 32e4174

File tree

59 files changed

+7205
-540
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

59 files changed

+7205
-540
lines changed
Lines changed: 161 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,179 @@
1-
name: Bug report
1+
name: Bug Report
22
description: Report a reproducible problem in the template or generated project
3-
labels: [bug]
3+
title: "[Bug]: "
4+
labels: ["bug", "triage"]
45
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to report this bug! Please fill out the sections below to help us resolve it quickly.
10+
11+
- type: dropdown
12+
id: bug-type
13+
attributes:
14+
label: Bug Type
15+
description: Where does this bug occur?
16+
options:
17+
- Template generation (copier copy/update)
18+
- Generated project code
19+
- Docker/Docker Compose
20+
- Deployment configuration (K8s/ECS/Fly.io/Render/EC2)
21+
- CI/CD pipelines
22+
- Documentation
23+
- Testing
24+
- Other
25+
validations:
26+
required: true
27+
28+
- type: textarea
29+
id: description
30+
attributes:
31+
label: Bug Description
32+
description: A clear and concise description of what the bug is.
33+
placeholder: Describe the bug...
34+
validations:
35+
required: true
36+
37+
- type: textarea
38+
id: expected-behavior
39+
attributes:
40+
label: Expected Behavior
41+
description: What did you expect to happen?
42+
placeholder: I expected...
43+
validations:
44+
required: true
45+
46+
- type: textarea
47+
id: actual-behavior
48+
attributes:
49+
label: Actual Behavior
50+
description: What actually happened?
51+
placeholder: Instead, what happened was...
52+
validations:
53+
required: true
54+
555
- type: textarea
56+
id: reproduction-steps
657
attributes:
7-
label: Description
8-
description: What happened? What did you expect?
9-
validations: { required: true }
58+
label: Steps to Reproduce
59+
description: Detailed steps to reproduce the behavior
60+
value: |
61+
1. Run `copier copy gh:CuriousLearner/django-keel my-project`
62+
2. Answer prompts with: [list your selections]
63+
3. Run `cd my-project && docker compose up`
64+
4. See error...
65+
validations:
66+
required: true
67+
1068
- type: input
69+
id: keel-version
70+
attributes:
71+
label: Django Keel Version
72+
description: Which version of the template are you using?
73+
placeholder: "e.g., 0.1.0, latest, commit hash"
74+
validations:
75+
required: true
76+
77+
- type: dropdown
78+
id: project-type
1179
attributes:
12-
label: Keel version
13-
placeholder: "e.g., 1.2.3"
14-
validations: { required: true }
80+
label: Project Type
81+
description: Which project type did you select?
82+
options:
83+
- saas
84+
- api
85+
- web-app
86+
- internal-tool
87+
- custom
88+
- Not applicable
89+
validations:
90+
required: true
91+
1592
- type: textarea
93+
id: copier-answers
1694
attributes:
17-
label: Copier answers
18-
description: Paste relevant keys (api, frontend, background_tasks, deployment_targets, etc.)
95+
label: Copier Configuration
96+
description: |
97+
Paste your `.copier-answers.yml` file or relevant configuration.
98+
Remove any sensitive information (project name, emails, etc.)
1999
placeholder: |
100+
_commit: abc123
101+
_src_path: gh:CuriousLearner/django-keel
102+
project_type: saas
20103
api: drf
21104
frontend: nextjs
22105
background_tasks: celery
23106
deployment_targets: [kubernetes]
107+
use_teams: true
108+
use_stripe: advanced
109+
render: yaml
110+
24111
- type: textarea
112+
id: environment
25113
attributes:
26-
label: Steps to reproduce
114+
label: Environment
115+
description: |
116+
Please provide details about your environment
27117
value: |
28-
1. copier copy gh:CuriousLearner/django-keel demo
29-
2. ...
30-
validations: { required: true }
118+
- OS: [e.g., macOS 14.0, Ubuntu 22.04, Windows 11]
119+
- Python version: [e.g., 3.12.1]
120+
- Copier version: [e.g., 9.0.0]
121+
- Docker version: [e.g., 24.0.0]
122+
- Docker Compose version: [e.g., 2.20.0]
123+
render: markdown
124+
validations:
125+
required: true
126+
127+
- type: textarea
128+
id: logs
129+
attributes:
130+
label: Error Logs / Screenshots
131+
description: |
132+
Paste relevant error messages, tracebacks, or screenshots.
133+
Use code blocks (```) for logs.
134+
placeholder: |
135+
```
136+
Paste error logs here
137+
```
138+
validations:
139+
required: false
140+
141+
- type: checkboxes
142+
id: troubleshooting
143+
attributes:
144+
label: Troubleshooting Steps Taken
145+
description: What have you tried so far?
146+
options:
147+
- label: Searched existing issues
148+
- label: Reviewed documentation
149+
- label: Tried with a fresh project generation
150+
- label: Verified all prerequisites are installed
151+
- label: Cleared Docker cache/volumes
152+
- label: Tested with latest template version
153+
154+
- type: dropdown
155+
id: severity
156+
attributes:
157+
label: Severity
158+
description: How severely does this bug affect your work?
159+
options:
160+
- Critical (Blocking, cannot proceed)
161+
- High (Major feature broken)
162+
- Medium (Feature partially broken)
163+
- Low (Minor issue, workaround available)
164+
validations:
165+
required: true
166+
31167
- type: textarea
168+
id: additional-context
169+
attributes:
170+
label: Additional Context
171+
description: Add any other context about the problem here (workarounds, related issues, etc.)
172+
placeholder: Any additional information...
173+
174+
- type: checkboxes
175+
id: contribution
32176
attributes:
33-
label: Logs / screenshots
34-
description: Paste error messages, tracebacks, or screenshots
177+
label: Contribution
178+
options:
179+
- label: I'd be willing to submit a PR to fix this issue

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: 📚 Documentation
4+
url: https://django-keel.readthedocs.io/
5+
about: Read the full documentation for Django Keel
6+
7+
- name: 💬 GitHub Discussions
8+
url: https://github.com/CuriousLearner/django-keel/discussions
9+
about: Ask questions, share ideas, and discuss with the community
10+
11+
- name: 🚀 Quick Start Guide
12+
url: https://django-keel.readthedocs.io/en/latest/getting-started/quickstart/
13+
about: Get started with Django Keel in 5 minutes
14+
15+
- name: 📖 Project Types Guide
16+
url: https://django-keel.readthedocs.io/en/latest/getting-started/project-types/
17+
about: Learn about different project types (SaaS, API, Web App, Internal Tool)
Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
name: Documentation Issue
2+
description: Report missing, incorrect, or unclear documentation
3+
title: "[Docs]: "
4+
labels: ["documentation", "triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for helping improve our documentation! Clear docs are essential for a great developer experience.
10+
11+
- type: dropdown
12+
id: doc-type
13+
attributes:
14+
label: Documentation Type
15+
description: What type of documentation issue is this?
16+
options:
17+
- Missing documentation
18+
- Incorrect/outdated information
19+
- Unclear or confusing explanation
20+
- Broken links
21+
- Code examples not working
22+
- Typo or grammar issue
23+
- Missing code examples
24+
- Other
25+
validations:
26+
required: true
27+
28+
- type: dropdown
29+
id: doc-location
30+
attributes:
31+
label: Documentation Location
32+
description: Where is the documentation issue?
33+
options:
34+
- README.md
35+
- ReadTheDocs (main documentation)
36+
- Generated project docs
37+
- Inline code comments
38+
- Copier prompt help text
39+
- CHANGELOG.md
40+
- CONTRIBUTING.md
41+
- Other
42+
validations:
43+
required: true
44+
45+
- type: textarea
46+
id: issue-description
47+
attributes:
48+
label: Issue Description
49+
description: |
50+
Describe the documentation problem clearly.
51+
If reporting incorrect information, explain what's wrong and what's correct.
52+
placeholder: |
53+
The documentation states [X], but actually [Y] happens.
54+
Or: The [feature] is not documented anywhere.
55+
validations:
56+
required: true
57+
58+
- type: textarea
59+
id: current-content
60+
attributes:
61+
label: Current Documentation
62+
description: |
63+
If applicable, paste the current documentation that needs improvement.
64+
Include the page URL or file path.
65+
placeholder: |
66+
File: docs/deployment/kubernetes.md
67+
Section: "Database Configuration"
68+
69+
Current text:
70+
```
71+
Paste current documentation here
72+
```
73+
74+
- type: textarea
75+
id: suggested-improvement
76+
attributes:
77+
label: Suggested Improvement
78+
description: |
79+
What changes would you suggest? Provide specific text, examples, or structure improvements.
80+
placeholder: |
81+
Suggested text:
82+
```
83+
Improved documentation here
84+
```
85+
86+
Or describe what should be added:
87+
- Add section explaining [X]
88+
- Include example showing [Y]
89+
- Link to related documentation about [Z]
90+
91+
- type: textarea
92+
id: context
93+
attributes:
94+
label: Additional Context
95+
description: |
96+
When did you encounter this issue? What were you trying to do?
97+
Was this during initial setup, deployment, or using a specific feature?
98+
placeholder: |
99+
I was trying to [action] and looked for documentation about [topic].
100+
The current docs didn't explain [specific aspect].
101+
102+
- type: dropdown
103+
id: audience
104+
attributes:
105+
label: Target Audience
106+
description: Who would benefit most from this documentation improvement?
107+
options:
108+
- New users (getting started)
109+
- Experienced Django developers
110+
- DevOps/deployment engineers
111+
- All users
112+
- Contributors
113+
validations:
114+
required: true
115+
116+
- type: checkboxes
117+
id: contribution
118+
attributes:
119+
label: Contribution
120+
options:
121+
- label: I'd be willing to submit a PR to improve this documentation

0 commit comments

Comments
 (0)