Skip to content

Commit bd557e5

Browse files
Add GitHub issue and PR templates (#44)
- Add bug report template with structured fields - Add feature request template for enhancement proposals - Add pull request template with checklist - Templates follow GitHub's YAML issue form format Co-authored-by: claude[bot] <41898282+claude[bot]@users.noreply.github.com> Co-authored-by: Kfir Stri <kfirstri@users.noreply.github.com>
1 parent 94fb174 commit bd557e5

3 files changed

Lines changed: 174 additions & 0 deletions

File tree

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
name: Bug Report
2+
description: Report a bug or unexpected behavior in the Base44 CLI
3+
title: "[Bug]: "
4+
labels: ["bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to report a bug! Please fill out the form below to help us investigate and fix the issue.
10+
11+
- type: textarea
12+
id: description
13+
attributes:
14+
label: Description
15+
description: A clear and concise description of what the bug is.
16+
placeholder: Tell us what went wrong...
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: steps
22+
attributes:
23+
label: Steps to Reproduce
24+
description: Steps to reproduce the behavior
25+
placeholder: |
26+
1. Run command '...'
27+
2. Enter input '...'
28+
3. See error
29+
validations:
30+
required: true
31+
32+
- type: textarea
33+
id: expected
34+
attributes:
35+
label: Expected Behavior
36+
description: What did you expect to happen?
37+
placeholder: I expected...
38+
validations:
39+
required: true
40+
41+
- type: textarea
42+
id: actual
43+
attributes:
44+
label: Actual Behavior
45+
description: What actually happened?
46+
placeholder: Instead, this happened...
47+
validations:
48+
required: true
49+
50+
- type: textarea
51+
id: environment
52+
attributes:
53+
label: Environment
54+
description: Please provide information about your environment
55+
placeholder: |
56+
- OS: [e.g. macOS 14.0, Ubuntu 22.04, Windows 11]
57+
- Node.js version: [e.g. 20.19.0]
58+
- CLI version: [e.g. 1.0.0]
59+
value: |
60+
- OS:
61+
- Node.js version:
62+
- CLI version:
63+
validations:
64+
required: true
65+
66+
- type: textarea
67+
id: logs
68+
attributes:
69+
label: Error Logs
70+
description: If applicable, paste any relevant error messages or logs
71+
render: shell
72+
73+
- type: textarea
74+
id: additional
75+
attributes:
76+
label: Additional Context
77+
description: Add any other context about the problem here (screenshots, config files, etc.)
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: Feature Request
2+
description: Suggest a new feature or enhancement for the Base44 CLI
3+
title: "[Feature]: "
4+
labels: ["enhancement"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for suggesting a new feature! Please fill out the form below to help us understand your idea.
10+
11+
- type: textarea
12+
id: problem
13+
attributes:
14+
label: Problem Statement
15+
description: Is your feature request related to a problem? Please describe.
16+
placeholder: I'm frustrated when...
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: solution
22+
attributes:
23+
label: Proposed Solution
24+
description: Describe the solution you'd like to see
25+
placeholder: I would like to be able to...
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 features?
34+
placeholder: I also thought about...
35+
36+
- type: textarea
37+
id: examples
38+
attributes:
39+
label: Usage Examples
40+
description: If applicable, provide examples of how you would use this feature
41+
placeholder: |
42+
```bash
43+
base44 new-command --option value
44+
```
45+
46+
- type: textarea
47+
id: additional
48+
attributes:
49+
label: Additional Context
50+
description: Add any other context, screenshots, or mockups about the feature request here

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
## Description
2+
3+
<!-- Provide a brief description of the changes in this PR -->
4+
5+
## Related Issue
6+
7+
<!-- Link to the issue this PR addresses, e.g., Fixes #123 or Closes #456 -->
8+
9+
## Type of Change
10+
11+
<!-- Mark the relevant option with an "x" -->
12+
13+
- [ ] Bug fix (non-breaking change which fixes an issue)
14+
- [ ] New feature (non-breaking change which adds functionality)
15+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
16+
- [ ] Documentation update
17+
- [ ] Refactoring (no functional changes)
18+
- [ ] Other (please describe):
19+
20+
## Changes Made
21+
22+
<!-- List the main changes made in this PR -->
23+
24+
-
25+
-
26+
-
27+
28+
## Testing
29+
30+
<!-- Describe how you tested these changes -->
31+
32+
- [ ] I have tested these changes locally
33+
- [ ] I have added/updated tests as needed
34+
- [ ] All tests pass (`npm test`)
35+
36+
## Checklist
37+
38+
- [ ] My code follows the project's style guidelines
39+
- [ ] I have performed a self-review of my own code
40+
- [ ] I have commented my code, particularly in hard-to-understand areas
41+
- [ ] I have made corresponding changes to the documentation (if applicable)
42+
- [ ] My changes generate no new warnings
43+
- [ ] I have updated AGENTS.md if I made architectural changes
44+
45+
## Additional Notes
46+
47+
<!-- Add any additional notes, screenshots, or context about the PR here -->

0 commit comments

Comments
 (0)