Closed
Description
We identified that it was a challenge for contributors to know how to contribute to projects both inside and outside of the GitHub organization.
@benjagm to define define success criteria, deliverables, and breakdown of tasks.
Assessed as medium-high impact/high effort during our collaborators summit 2023.
Scope
The scope of this project includes:
- Identify the affected repositories inside and outside the github organization.
- Assess the current state of the contributor journey.
- Refine the contributing template.
- Refine the contributing guidelines to make them consistent and provide a way to naturally navigate from one to another project.
- Adapt the website and slack contribution experience to the enhanced version on Github.
- Improve the recognition system.
Objectives
The objectives of this project are:
- Reduce friction for new contributors.
- Increase the total number of contributors.
- Provide clarity on the total number of contributors including non-code contributions and repositories outside the organization.
- Increase the number of PRs and issues.
- Increase the number of closed issues.
Plan
-
Research
- Identify the repositories inside and outside the organization. #425
- Identify the list of contribution types of contribution. This is the prioritized list.
- Sponsors
- Adopters
- Website development
- Documentation
- Blogs posts
- Case Studies
- Community Management e.g. CoC Committee
- Spec development
- Bowtie development
- Test Suite development
- Design
- Answer questions
- TSC
- Define a list of common resources for refining the Contribution journeys #508
-
Implementation
Asses and enhance Contributor Journey for each type of contribution doing the following:
Issues will be created for each type.
This is the list of actions to complete for each type:- Review the Readme or equivalent.
- The main place with the link to contribute.
- Repo shield badges.
- Review the contributing guide or equivalent and improve if necessary
- All contributors are visible and aligned
- Review all the places where this contribution path is enabled and make it consistent
- Issues are triage and label issues
- Issues are easy to find and progress is easy to follow.
- Identify and create workflows to thank and congratulate contributions
- Update the contribution experience handbook.
Issues by type:
- Refine the sponsors contribution experience #509
- Org wide contributing
- Add templates to improve the adopters journey #550
- Refine the community contributor experience #583
- Refine the website/front-end contribution experience #551
- Refine the docs contribution experience #556
- Bowtie contribution experience.
- Test suite contribution experience.
-
Metrics
- Confirm the decided metrics.
Success Metrics
The metrics for measuring the success of the documentation project includes:
- ## New sponsors.
- ## New adopters.
- ## New case studies.
- ## New guest blog posts.
- +##% YoY Number of contributors.
- +##% YoY Number of PRs and issues.
- +##% YoY Number of closed issues.
- -##% YoY contributors' churn rate.
Risks
The risks associated with this project includes:
Metadata
Metadata
Assignees
Type
Projects
Status
Done