--- robots: nofollow, noindex tags: contribution --- # Contribution + Community Checklist ## Kudos A lot of this information is being pieced together from personal observations and information documented here: - https://opensource.guide/ - https://github.com/microsoft/vscode/wiki - Feedback from customers - https://github.com/microsoft/fluentui/issues/13212#issuecomment-690525142 ## GitHub Repo **Goal:** Have a GitHub repository that is welcoming to contributors to invest their time and effort in the success of the project **Measure:** Increase in 'users' moving to 'contributors', Number of contributors has increased to X Read more about the [contributor funnel:](https://mikemcquaid.com/2018/08/14/the-open-source-contributor-funnel-why-people-dont-contribute-to-your-open-source-project/) ![](https://i.imgur.com/Ds8ZUwz.png) ### Repo Maintainer's Checklist - [ ] Have a friendly `README.md` file - [Draft]() - [Windows Terminal README Example](https://github.com/Microsoft/Terminal) - [ ] Have a clear `CONTRIBUTION.md` file - [Draft]() - [VS Code CONTRIBUTION.md Example](https://github.com/microsoft/vscode/blob/master/CONTRIBUTING.md) - [ ] Ensure you outline what contributions you accept: bugs, feedback, feature additions, etc. - [ ] Have `Issue Template` - [Link]() - [Fluent UI React Example](https://github.com/microsoft/fluentui/tree/master/.github) - [ ] Have a `Pull Request Template` - [Link]() - [Fluent UI React Example](https://github.com/microsoft/fluentui/tree/master/.github) - [ ] Label issues as `Good first issue` for first time contributors [Query]() - [VS Code Example](https://github.com/microsoft/vscode/contribute) - [ ] Label issues as `Help wanted` for issues that we believe the contributors could pick up and implement - [Query]() - - [ ] Have a wiki that outlines the Triage Process - [Draft]() - [VS Code Example](https://github.com/microsoft/vscode/wiki/Issue-Tracking) - [ ] What's the state machine look like - [ ] What's do the labels mean - [ ] Define timelines and timeouts for stale issues ## So you want to contribute a component - Guidelines - [todo] Update create package scaffold checklist, conformance tests, doc files, test stubs, etc. - Needs to pass our conformance tests - Follow this checklist - Questions - Is it worth building this component - Component anatomny - Discussion - File an 1-pager RFC on GitHub - We review - Goals - Low bar of entry for creating a shareable self-used component - Isolate within it's own package - Using package in the future to iterate on the pattern in the future