Skip to content

Commit e4e5540

Browse files
kawaaaasclaude
andcommitted
chore: add GitHub issue templates and improve PR template
Add YAML-based issue templates for bug reports and feature requests, and restructure the PR template with summary, checklist, and type of change sections. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent d3216ab commit e4e5540

4 files changed

Lines changed: 205 additions & 1 deletion

File tree

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
name: Bug Report
2+
description: Report a bug or unexpected behavior
3+
labels: ['bug']
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for taking the time to report a bug!
9+
10+
- type: input
11+
id: version
12+
attributes:
13+
label: Package Version
14+
description: Which version of `serverless-spa-construct` are you using?
15+
placeholder: e.g. 0.1.0
16+
validations:
17+
required: true
18+
19+
- type: input
20+
id: cdk-version
21+
attributes:
22+
label: AWS CDK Version
23+
description: Which version of `aws-cdk-lib` are you using?
24+
placeholder: e.g. 2.189.1
25+
validations:
26+
required: true
27+
28+
- type: dropdown
29+
id: construct
30+
attributes:
31+
label: Affected Construct
32+
description: Which construct is affected?
33+
multiple: true
34+
options:
35+
- ServerlessSpaConstruct
36+
- ServerlessSpaSecurityConstruct
37+
- DatabaseConstruct
38+
- AuthConstruct
39+
- ApiConstruct
40+
- FrontendConstruct
41+
- WafConstruct
42+
- CertificateConstruct
43+
- SecretConstruct
44+
- LambdaEdgeConstruct
45+
- SsmConstruct
46+
- Other
47+
validations:
48+
required: true
49+
50+
- type: dropdown
51+
id: factory-method
52+
attributes:
53+
label: Factory Method (if applicable)
54+
description: Which factory method are you using?
55+
options:
56+
- N/A (using low-level constructs)
57+
- minimal()
58+
- withWaf()
59+
- withCustomDomain()
60+
- withCustomDomainAndWaf()
61+
- withCertificate()
62+
- withWafAndCertificate()
63+
64+
- type: textarea
65+
id: description
66+
attributes:
67+
label: Description
68+
description: A clear description of the bug.
69+
validations:
70+
required: true
71+
72+
- type: textarea
73+
id: reproduction
74+
attributes:
75+
label: Steps to Reproduce
76+
description: Minimal code or steps to reproduce the issue.
77+
placeholder: |
78+
1. Create a stack with ...
79+
2. Run `cdk synth` or `cdk deploy`
80+
3. See error ...
81+
validations:
82+
required: true
83+
84+
- type: textarea
85+
id: expected
86+
attributes:
87+
label: Expected Behavior
88+
description: What did you expect to happen?
89+
validations:
90+
required: true
91+
92+
- type: textarea
93+
id: actual
94+
attributes:
95+
label: Actual Behavior
96+
description: What actually happened? Include error messages or CloudFormation errors if applicable.
97+
validations:
98+
required: true
99+
100+
- type: textarea
101+
id: additional
102+
attributes:
103+
label: Additional Context
104+
description: Any additional context, stack traces, or screenshots.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: true
Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
name: Feature Request
2+
description: Suggest a new feature or improvement
3+
labels: ['enhancement']
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for suggesting a feature!
9+
10+
- type: dropdown
11+
id: area
12+
attributes:
13+
label: Area
14+
description: Which area does this feature relate to?
15+
multiple: true
16+
options:
17+
- ServerlessSpaConstruct (high-level)
18+
- ServerlessSpaSecurityConstruct (high-level)
19+
- Database / DynamoDB
20+
- Auth / Cognito
21+
- API Gateway / Lambda
22+
- Frontend / CloudFront / S3
23+
- WAF
24+
- Certificate / ACM
25+
- Secret / Secrets Manager
26+
- Lambda@Edge
27+
- SSM Parameter Store
28+
- Documentation
29+
- Other
30+
validations:
31+
required: true
32+
33+
- type: textarea
34+
id: problem
35+
attributes:
36+
label: Problem
37+
description: What problem does this feature solve? What use case is not currently supported?
38+
validations:
39+
required: true
40+
41+
- type: textarea
42+
id: solution
43+
attributes:
44+
label: Proposed Solution
45+
description: How do you think this should work? Include example API or code snippets if possible.
46+
placeholder: |
47+
```ts
48+
// Example of desired API
49+
ServerlessSpaConstruct.minimal(this, "App", {
50+
// ...
51+
});
52+
```
53+
54+
- type: textarea
55+
id: alternatives
56+
attributes:
57+
label: Alternatives Considered
58+
description: Are there other approaches you've considered or workarounds you're currently using?
59+
60+
- type: textarea
61+
id: additional
62+
attributes:
63+
label: Additional Context
64+
description: Any additional context, references, or screenshots.

.github/pull_request_template.md

Lines changed: 36 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)