Skip to content

Commit 2fb61f6

Browse files
krokokokrokoko
authored
chore: initial documentation (#5)
* Add templates for bug report, documentation and feature request * add code of conduct, update repo stability, and gitignore for macOS users * add dev and design guidelines, contribution, readme and changelog * update branch name for main
1 parent b38733c commit 2fb61f6

12 files changed

+580
-32
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 146 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,146 @@
1+
---
2+
name: "🐛 Bug Report"
3+
description: Report a bug
4+
title: "(module name): (short issue description)"
5+
labels: [bug, needs-triage]
6+
assignees: []
7+
body:
8+
- type: textarea
9+
id: description
10+
attributes:
11+
label: Describe the bug
12+
description: What is the problem? A clear and concise description of the bug.
13+
validations:
14+
required: true
15+
- type: textarea
16+
id: expected
17+
attributes:
18+
label: Expected Behavior
19+
description: |
20+
What did you expect to happen?
21+
validations:
22+
required: true
23+
- type: textarea
24+
id: current
25+
attributes:
26+
label: Current Behavior
27+
description: |
28+
What actually happened?
29+
30+
Please include full errors, uncaught exceptions, stack traces, and relevant logs.
31+
If service responses are relevant, please include wire logs.
32+
validations:
33+
required: true
34+
- type: textarea
35+
id: reproduction
36+
attributes:
37+
label: Reproduction Steps
38+
description: |
39+
Provide a self-contained, concise snippet of code that can be used to reproduce the issue.
40+
For more complex issues provide a repo with the smallest sample that reproduces the bug.
41+
42+
Avoid including business logic or unrelated code, it makes diagnosis more difficult.
43+
The code sample should be an SSCCE. See http://sscce.org/ for details. In short, please provide a code sample that we can copy/paste, run and reproduce.
44+
validations:
45+
required: true
46+
- type: textarea
47+
id: solution
48+
attributes:
49+
label: Possible Solution
50+
description: |
51+
Suggest a fix/reason for the bug
52+
validations:
53+
required: false
54+
- type: textarea
55+
id: context
56+
attributes:
57+
label: Additional Information/Context
58+
description: |
59+
Anything else that might be relevant for troubleshooting this bug. Providing context helps us come up with a solution that is most useful in the real world.
60+
validations:
61+
required: false
62+
63+
- type: input
64+
id: cdk-version
65+
attributes:
66+
label: CDK CLI Version
67+
description: Output of `cdk version`
68+
validations:
69+
required: true
70+
71+
- type: input
72+
id: framework-version
73+
attributes:
74+
label: Framework Version
75+
validations:
76+
required: false
77+
78+
- type: input
79+
id: node-version
80+
attributes:
81+
label: Node.js Version
82+
validations:
83+
required: true
84+
85+
- type: input
86+
id: operating-system
87+
attributes:
88+
label: OS
89+
validations:
90+
required: true
91+
92+
- type: dropdown
93+
id: language
94+
attributes:
95+
label: Language
96+
multiple: true
97+
options:
98+
- Typescript
99+
- Python
100+
- .NET
101+
- Java
102+
- Go
103+
validations:
104+
required: true
105+
106+
- type: input
107+
id: language-version
108+
attributes:
109+
label: Language Version
110+
description: E.g. TypeScript (3.8.3) | Java (8) | Python (3.7.3)
111+
validations:
112+
required: false
113+
114+
- type: input
115+
id: region
116+
attributes:
117+
label: Region experiencing the issue
118+
description: For instance, us-east-1
119+
validations:
120+
required: true
121+
122+
- type: textarea
123+
id: modified
124+
attributes:
125+
label: Code modification
126+
description: |
127+
Was the solution modified from the version published on this repository? If the answer to the previous question was yes, are the changes available on GitHub?
128+
validations:
129+
required: true
130+
131+
- type: textarea
132+
id: other
133+
attributes:
134+
label: Other information
135+
description: |
136+
e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. associated pull-request, stackoverflow, slack, etc
137+
validations:
138+
required: false
139+
140+
- type: checkboxes
141+
attributes:
142+
label: Service quota
143+
description: Have you checked your [service quotas](https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html) for the services this sample uses?
144+
options:
145+
- label: I have reviewed the service quotas for this construct
146+
required: true

‎.github/ISSUE_TEMPLATE/documentation.yml‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: "📕 Documentation Issue"
3+
description: Report an issue in the API Reference documentation or Developer Guide
4+
title: "(module name): (short issue description)"
5+
labels: [documentation, needs-triage]
6+
assignees: []
7+
body:
8+
- type: textarea
9+
id: description
10+
attributes:
11+
label: Describe the issue
12+
description: A clear and concise description of the issue.
13+
validations:
14+
required: true
15+
16+
- type: textarea
17+
id: links
18+
attributes:
19+
label: Links
20+
description: |
21+
Include links to affected documentation page(s).
22+
validations:
23+
required: true

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
name: 🚀 Feature Request
3+
description: Suggest an idea for this project
4+
title: "(module name): (short issue description)"
5+
labels: [feature-request, needs-triage]
6+
assignees: []
7+
body:
8+
- type: textarea
9+
id: description
10+
attributes:
11+
label: Describe the feature
12+
description: A clear and concise description of the feature you are proposing.
13+
validations:
14+
required: true
15+
- type: textarea
16+
id: use-case
17+
attributes:
18+
label: Use Case
19+
description: |
20+
Why do you need this feature? For example: "I'm always frustrated when..."
21+
validations:
22+
required: true
23+
- type: textarea
24+
id: solution
25+
attributes:
26+
label: Proposed Solution
27+
description: |
28+
Suggest how to implement the addition or change. Please include prototype/workaround/sketch/reference implementation.
29+
validations:
30+
required: false
31+
- type: textarea
32+
id: other
33+
attributes:
34+
label: Other Information
35+
description: |
36+
Any alternative solutions or features you considered, a more detailed explanation, stack traces, related issues, links for context, etc.
37+
validations:
38+
required: false
39+
- type: checkboxes
40+
id: ack
41+
attributes:
42+
label: Acknowledgements
43+
options:
44+
- label: I may be able to implement this feature request
45+
required: false
46+
- label: This feature might incur a breaking change
47+
required: false

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎.projenrc.ts‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,5 +38,7 @@ const project = new awscdk.AwsCdkConstructLibrary({
3838
docgen: false,
3939
licensed: true,
4040
license: 'Apache-2.0',
41+
gitignore: ['*.DS_STORE'],
42+
stability: 'experimental',
4143
});
4244
project.synth();

‎CHANGELOG.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# CDK Emerging Tech Constructs V0.0.0 (2023-09-21)
2+
3+
Based on CDK library version 2.96.2
4+
5+
***
6+
© Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.

‎CODE_OF_CONDUCT.md‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
## Code of Conduct
2-
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
3-
For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
2+
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
3+
For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
44
[email protected] with any additional questions or comments.
5+
6+
***
7+
© Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.

0 commit comments

Comments
 (0)