aws / aws/aws-cdk

CONTRIBUTING.md: Rewrite and restructure introduction and getting started process

Open
#33,755 1 comment 0 reactions 0 assignees View on GitHub
documentation effort/medium p1
Dominant language
TypeScript
Stars
12.9k
Forks
4.6k
Avg merge
2d 3h
Merged PRs (30d)
83

Description

### Describe the issue

This Issue is part of an ongoing effort to simplify and improve the "Contributing to the AWS CDK" process. To start, we should improve the "Introduction" and "Getting started" sections by simplifying and revising content. For content that is important to know, but not necessary for everyone, we should move this content to a reference section. Also, my suggestion is that we remove the initial flowchart since the simplified process negates the need for it. Lastly, we should provide instructions for searching Issues and PRs and submitting Issues.

### Links

https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md

Contributor guide

Open the contributing guide

Research direction

Start by reading CONTRIBUTING.md, focusing on the Introduction and Getting started sections named in the issue. Review the existing flowchart and identify content that belongs in a reference section, then add guidance for searching Issues and PRs and submitting Issues. Done means the contribution process is simpler, reorganized, and covers the requested guidance.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.