Skip to content

Commit 46c2793

Browse files
committed
update contributing.md and add issue and pr templates
1 parent 42afa60 commit 46c2793

File tree

4 files changed

+93
-0
lines changed

4 files changed

+93
-0
lines changed
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
name: 📚 Documentation Bug Report
3+
about: Report an issue with the AWS CDK documentation
4+
title: "[Documentation Bug]: "
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
### Documentation Page
11+
<!-- Add a link to the affected documentation page -->
12+
13+
### Issue Description
14+
<!-- Clearly describe what's incorrect, unclear, or missing in the documentation -->
15+
16+
### Expected Information
17+
<!-- Describe what you expected to find or how you expected the documentation to be structured -->
18+
19+
### Screenshots
20+
<!-- If applicable, add screenshots to help explain the issue -->
21+
22+
### Suggested Fix
23+
<!-- If you have a specific suggestion for how to fix the issue, please describe it here -->
24+
25+
### Additional Context
26+
<!-- Add any other context about the problem here -->
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
name: 📝 Documentation Improvement Request
3+
about: Suggest an improvement or addition to the AWS CDK documentation
4+
title: "[Documentation Improvement]: "
5+
labels: improvement
6+
assignees: ''
7+
8+
---
9+
10+
### Documentation Area
11+
<!-- Describe which part of the documentation needs enhancement (e.g., specific guide, section, or topic) -->
12+
13+
### Enhancement Description
14+
<!-- Clearly describe what you'd like to see added or improved in the documentation -->
15+
16+
### Why is this enhancement needed?
17+
<!-- Explain why this enhancement would be valuable for users of the AWS CDK -->
18+
19+
### Proposed Content
20+
<!-- If you have specific content suggestions, please outline them here -->
21+
22+
### Examples
23+
<!-- If applicable, add examples, code snippets, or references to other documentation that could help -->
24+
25+
### Additional Context
26+
<!-- Add any other context about the request here -->

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
## Description
2+
3+
**Documentation Change Type:**
4+
5+
- [ ] Typo/grammar fix
6+
- [ ] Clarification or minor improvement
7+
- [ ] New example or code snippet
8+
- [ ] New section or topic
9+
- [ ] Major restructuring or enhancement
10+
11+
**Affected Documentation Page(s):**
12+
<!-- Add links to the affected pages -->
13+
14+
## Description of Changes
15+
<!-- Provide a clear and concise description of your changes -->
16+
17+
## Motivation and Context
18+
<!-- Why are these changes required? What problem do they solve? -->
19+
20+
## How Has This Been Validated?
21+
<!-- Have you previewed the changes locally using asciidoctor or GitHub's preview functionality? -->
22+
23+
## Screenshots (if appropriate)
24+
<!-- Include screenshots of the documentation before and after your changes -->
25+
26+
## Checklist
27+
28+
- [ ] My changes follow the [AsciiDoc syntax](./CONTRIBUTING.md#asciidoc-syntax-reference) guidelines
29+
- [ ] I have previewed my changes using GitHub's preview or a local AsciiDoc renderer
30+
- [ ] My changes maintain consistent formatting with the rest of the documentation
31+
- [ ] I have checked that all links work correctly
32+
33+
## Additional Information
34+
<!-- Any additional information or context that might be helpful for reviewers -->

CONTRIBUTING.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,11 @@ We recommend creating or finding an issue first for:
6060
- Significant reorganization of existing content.
6161
- Any change that might benefit from discussion before implementation.
6262

63+
When creating a new issue, you'll find these templates to help structure your feedback:
64+
65+
- **Documentation Bug Report**: Use this template to report incorrect, unclear, or missing information.
66+
- **Documentation Improvement Request**: Use this template to suggest new content or enhancements.
67+
6368
For simple changes like typos, grammatical errors, or minor clarifications, you can directly submit a pull request without an issue.
6469

6570
## Getting started
@@ -136,6 +141,8 @@ When making changes to the documentation:
136141

137142
### Pull Request review process
138143

144+
When you create a pull request, a template will automatically be loaded with sections to help you provide all the necessary information about your changes. Fill out all relevant sections to help reviewers understand your contribution.
145+
139146
After submitting your PR:
140147

141148
1. Maintainers will review your changes.

0 commit comments

Comments
 (0)