Skip to content

Commit

Permalink
chore: convert contribution diagram from png to mermaid (#27998)
Browse files Browse the repository at this point in the history
Makes our diagram editable now that it is mermaid.

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
  • Loading branch information
scanlonp authored Nov 17, 2023
1 parent a1a6131 commit d1417a0
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 1 deletion.
42 changes: 41 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,47 @@ let us know if it's not up-to-date (even better, submit a PR with your correcti
- [Related Repositories](#related-repositories)

## Contribution Workflow Diagram
![A workflow diagram for contributing code to the aws-cdk ecosytem](./docs/contribution_flow.png)
```mermaid
flowchart TD
A(Identify Desired Functionality) --> B(Search For Existing Artifacts)
B --> C[External Packages]
B --> D[Relevant Issues And PRs]
C --> E{"Does A High Quality
Solution Exist?"}
D --> F{"Is There A PR In Progress"}
E --> |Yes| G(("Ask How You
Can Help"))
F --> |Yes| G
E --> |No| H(Evaluate Where To Contribute)
F --> |No| H
H --> I{"Is There Clear Evidence
For Inclusion In AWS-CDK"}
I --> |Yes| subEvidence
I --> |No| J{"Do You Want To Pursue Eventual
Inclusion In AWS-CDK"}
J --> |No| L(("Create Private
Implementation"))
J --> |Yes| K((Publish A Package))
subEvidence --> M(Make Pull Request)
M --> N{"Passes CI Checks, Linters,
And Follows Design Guidelines"}
N --> O(Review)
O --> |Accepted| R(Hooray!)
O --> P(Changes Requested)
P --> Q(Make Changes)
Q --> O
O --> |Refused| K
subgraph subEvidence[Gather Evidence]
direction LR
engagement[Engagement from Multiple users]
core[Intersects With Core Framework Concerns]
quality["Clear, Well Defined, Solution With
Limited Scope And Clear Boundaries"]
external[External Packages]
issues[Relevant Issues And PRs]
end
```

## Where to Contribute

Expand Down
Binary file removed docs/contribution_flow.png
Binary file not shown.

0 comments on commit d1417a0

Please sign in to comment.