Skip to content

DOC: improve accessibility of the contributor guide flowchart #866

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
romanlutz merged 1 commit into from
Apr 9, 2025
Merged

DOC: improve accessibility of the contributor guide flowchart #866

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 26 additions & 17 deletions doc/contributing/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,28 +11,37 @@ For a more detailed overview on how to contribute read below.
## Ways to contribute

```{mermaid}
%%{
init: {
'theme': 'base',
'themeVariables': {
'lineColor': '#f39e3d',
'secondaryColor': '#f6bb77',
'primaryBorderColor': '#f39e3d'
}
}
}%%
flowchart TB
Start(You are here!) --> PathSplit{Do you already have a specific problem/feature request/bug that you want to fix/address?}
PathSplit -- yes --> IssueCheck
IssueCheck{Is there a GitHub issue for this problem?} -- yes --> IssueExists
IssueCheck -- no --> CreateIssue
PathSplit -- "  yes  " --> IssueCheck
IssueCheck{Is there a GitHub issue for this problem?} -- "  yes  " --> IssueExists
IssueCheck -- "  no  " --> CreateIssue
CreateIssue(Create a GitHub issue) --> IssueCuration
IssueCuration(Wait for response from maintainers) --> IssueExists
IssueExists{Is the issue marked as *help wanted* and/or *good first issue*} -- yes --> IssueClaimedCheck
IssueExists -- no --> IssueNotReady(Feel free to comment on the issue to raise awareness.)
IssueClaimedCheck{Is the issue already claimed by someone?} -- yes --> IssueClaimed(If there hasn't been progress for a while feel free to comment on the issue. In the meantime, feel free to pick up a different issue.)
IssueClaimedCheck -- no --> ClaimIssue(Claim the issue for yourself by commenting *I would like to take this.* If anything is unclear ask on the issue.)
IssueExists{Is the issue marked as *help wanted* and/or *good first issue*} -- "  yes  " --> IssueClaimedCheck
IssueExists -- "  no  " --> IssueNotReady(Feel free to comment on the issue to raise awareness.)
IssueClaimedCheck{Is the issue already claimed by someone?} -- "  yes  " --> IssueClaimed(If there hasn't been progress for a while feel free to comment on the issue. In the meantime, feel free to pick up a different issue.)
IssueClaimedCheck -- "  no  " --> ClaimIssue(Claim the issue for yourself by commenting *I would like to take this.* If anything is unclear ask on the issue.)
ClaimIssue --> SubmitPR(Submit pull request)
SubmitPR -- PR feedback --> PR(Address feedback)
PR -- PR feedback --> PR
PR -- maintainer merges PR ----> Merged(PR completed! Thank you!)
PathSplit -- no --> ContribOrUse{Do you want to contribute right away or use PyRIT first?}
ContribOrUse -- use --> UseIssue{Is something not working? Do you want additional features?}
UseIssue -- yes --> IssueCheck
UseIssue -- no --> NoProblems(Nice! Let us know how it goes.)
ContribOrUse -- contribute --> CheckIssueList(Check our GitHub issues with tags *help wanted* and *good first issue*)
CheckIssueList -- find interesting issue --> IssueClaimedCheck

SubmitPR -- "  PR feedback  " --> PR(Address feedback)
PR -- "  PR feedback  " --> PR
PR -- "  maintainer merges PR  " ----> Merged(PR completed! Thank you!)
PathSplit -- "  no  " --> ContribOrUse{Do you want to contribute right away or use PyRIT first?}
ContribOrUse -- "  use  " --> UseIssue{Is something not working? Do you want additional features?}
UseIssue -- "  yes  " --> IssueCheck
UseIssue -- "  no  " --> NoProblems(Nice! Let us know how it goes.)
ContribOrUse -- "  contribute  " --> CheckIssueList(Check our GitHub issues with tags *help wanted* and *good first issue*)
CheckIssueList -- "  find interesting issue  " --> IssueClaimedCheck
```

Contributions come in many forms such as *writing code* or *adding examples*.
Expand Down