Skip to content
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

chore: update contributing guide with merit badger info #22172

Merged
merged 2 commits into from
Sep 22, 2022
Merged

chore: update contributing guide with merit badger info #22172

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
85ce08f
update contributing guide
kaizencc Sep 21, 2022
5c7cc4e
Merge branch 'main' into conroy/meritbadger
mergify[bot] Sep 22, 2022
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
19 changes: 19 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ let us know if it's not up-to-date (even better, submit a PR with your correcti
- [Debugging](#debugging)
- [Connecting the VS Code Debugger](#connecting-the-vs-code-debugger)
- [Run a CDK unit test in the debugger](#run-a-cdk-unit-test-in-the-debugger)
- [Badges (Pilot Program)](#badges-pilot-program)
- [Related Repositories](#related-repositories)

## Getting Started
Expand Down Expand Up @@ -1116,6 +1117,24 @@ $ node --inspect-brk /path/to/aws-cdk/node_modules/.bin/jest -i -t 'TESTNAME'

3. On the `Run` pane of VSCode, select the run configuration **Attach to NodeJS** and click the button.

## Badges (Pilot Program)

> CDK Merit Badges is a Pilot Program. The badges you get are experimental and may change.

CDK Merit Badges is a program aimed at enhancing the CDK contributor experience. When you
submit new pull requests to the CDK repository, you will receive a merit badge that reflects
Naumel marked this conversation as resolved.
Show resolved Hide resolved
how many prior successful contributions you have to the repository. Right now, these badges
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Expect questions regarding what will they be used for in the future?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know that is the natural follow up question, but I mean to leave this ambiguous. I don't want to commit to any ideas, and we don't know if/how we will use them in the future. I do mean to suggest that it's possible that badges could have different rewards/incentives attached in the future, just not now.

are just for fun and are meant as a small incentive to continued contributions to the CDK.

The badges have the following meaning:

- `beginning-contributor`: contributed between 0-2 PRs to the CDK
- `repeat-contributor`: contributed between 3-5 PRs to the CDK
- `valued-contributor`: contributed between 6-12 PRs to the CDK
- `admired-contributor`: contributed between 13-24 PRs to the CDK
- `star-contributor`: contributed between 25-49 PRs to the CDK
- `distinguished-contributor`: contributed 50+ PRs to the CDK

## Related Repositories

* [Samples](https://github.com/aws-samples/aws-cdk-examples): includes sample code in multiple languages
Expand Down