Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
When the project health score is low for an open-source project like CNCF or Kubernetes, here are some steps a user can take:
Review the project's health metrics: Understand what factors contribute to the low health score. Is it due to a lack of contributors, outdated documentation, or poor code quality? Knowing the root cause will help you focus on the right areas.
Join the community: Engage with the project's community by participating in discussions on forums, GitHub issues, or mailing lists. This will help you understand the project's dynamics, identify potential issues, and potentially find opportunities to contribute.
Contribute to the project: With a low health score, there may be opportunities to contribute to the project. This could be in the form of:
Code contributions: Fixing bugs, improving code quality, or implementing new features.
Documentation updates: Ensuring that the documentation is up-to-date, accurate, and easy to understand.
Testing and validation: Helping to identify and fix issues, ensuring that the project is stable and reliable.
Community outreach: Helping to attract new contributors, promoting the project, and building a stronger community.
Identify potential roadblocks: Be aware of potential roadblocks that might hinder your contributions, such as:
Complexity: The project may be too complex for you to contribute to, especially if you're new to the area.
Time commitment: Contributing to an open-source project requires a significant time commitment, which may not be feasible for everyone.
Consider forking the project: If the project is not actively maintained or has a low health score, you can consider forking the project to create a new, improved version. This can be a significant undertaking, but it can also provide an opportunity to create a more sustainable and maintainable project.
Raise awareness: If you're unable to contribute directly, you can still raise awareness about the project's low health score. Share your concerns with the community, and encourage others to contribute or help address the issues.
Explore alternative projects: If the project is too far gone, it might be time to explore alternative projects with a higher health score. This will ensure that you are contributing to a project that is well-maintained, stable, and has a strong community.
Select the project from the landing page or from the foundation page.
From the main navigation, select Reports and then click Activities Dashboard.
In the top-right corner, you will find the date filter option.
Select the desired start and end dates for the data you want to analyze.
Click Apply to update the dashboard with the selected date range.
Find the Platforms drop-down menu.
Choose a data source from the available options (e.g., GitHub or Git).
It shows the total number of all the activities that are performed by contributors for the project. Hover over the data points to view specific activity counts for each date.
Explore the Activities Today, Activities This Week, and Activities Organization This Month charts. The Charts are date-filter independent. They show real-time data.
Click View to expand the list on the right side and see the list of activities.
Download the list in CSV format for analysis.
Move to the Activities chart section.
Use the drop-down to select Daily, Weekly, or Monthly data.
Gain insights into the growth of activities over time.
Navigate to the Activities by Platform chart.
You will see the overall percentage distribution across the different platforms.
Click > icon to see the detailed distribution of activities on the different platforms.
Explore the Leaderboard section for activities by type.
Review the types of activities (e.g., code commits, issues) and their corresponding counts.
Select the project from the landing page or the foundation page.
From the main navigation, select Reports, and click Retention Dashboard.
On the top-right corner, locate the date filter option.
Click on it to open.
Choose your desired duration to focus on specific data.
Click Apply to update the dashboard with your selected date range.
Find the Platforms drop-down menu.
Choose a data source from the available options (e.g., GitHub or Git).
The dashboard updates to display insights relevant to your selected platform.
Locate the Cohort Size drop-down menu.
Choose either Weekly or Monthly to define the cohort size for analysis.
The dashboard adjusts to display data based on your selected cohort size.
The retention rate in open-source projects measures the percentage of contributors who continue to be actively engaged in the project over a specified period.
For a specific time period, the retention rate for contributors is calculated by dividing the number of contributors who remain active during the current and previous time period by the total number of contributors who were active in the previous time frame.
Explore the Retention Rate Chart section.
Observe the chart that visualizes the retention rate of contributors over time.
This chart shows the percentage of contributors who continue to engage with your project over the defined cohort period.
This metric provides insights into how consistently contributors are involved in your open source project over a specific period.
Review the Average Number of Contributor Activities metric.
Gain insights into the average level of contributor activity within the defined cohort.
This chart helps you understand the retention of contributors over time. It provides insights into how many new contributors joined in a specific month and how many of them remained actively engaged in subsequent months.
Project popularity can be measured using various metrics, including project forks and GitHub stars. This guide provides an overview of how to analyze project popularity using these metrics.
A project fork occurs when someone creates a copy of a repository (project) on GitHub.
Forks can be used to create a modified version of the original project or to contribute to the original project by sending pull requests.
A GitHub Star is a way for users to show their appreciation for a project by clicking the star button on the project's repository page.
Stars indicate that a user wants to keep track of a project's updates.
To analyze project popularity, follow these steps:
Fork and Star Count: Compare the number of forks and stars a project has over time.
Fork and Star Growth Rate: Calculate the rate at which the number of forks and stars is increasing or decreasing.
Fork and Star Distribution: Analyze the distribution of forks and stars among different contributors or organizations.
Metrics for Project Popularity
The following metrics can be used to show project popularity within a selected period:
The Organizations' reports provide insights into the individuals who have contributed to the project. The report gives you key metrics that you can use to assess a healthy contribution from multiple organizations.
Select the project from the landing page or from the foundation page.
On the left navigation pane, click Reports>Organizations.
Select the repositories from the drop-down menu to analyze the data for the particular repository.
In the top-right corner, you will find the date filter option.
Click on the date filter to open a calendar.
Select the desired start and end dates for the data you want to analyze.
Click Apply to update the dashboard with the selected date range.
Locate the Display Only New Organizations toggle button.
Toggle it on to display data only for new organizations within the selected period.
Toggle it off to view data for all organizations.
Explore the Total Organizations chart section. When you toggle the New Organizations button, it displays the total number of new organizations.
Hover over the data points to view specific counts for that time.
Explore the Active Organizations Today, Active Organizations This Week, or Active Organizations This Month charts. The Charts are date filter independent. They show real-time data
Click View to expand the list on the right side and see the list of organizations.
The chart shows new organizations when you toggle on the Display Only New Organizations Button.
Navigate to the Leaderboard section.
You will find a list of the most active contributors.
Review their names and corresponding activity levels.
Locate the drop-down menu for data source selection. For more information, see .
Metric | Description |
Fork Count | Total number of forks a project has received over a specific period. |
Star Count | Total number of stars a project has received over a specific period. |
Fork Growth Rate | Rate at which the number of forks is increasing or decreasing over a specific period. |
Star Growth Rate | Rate at which the number of stars is increasing or decreasing over a specific period. |
Fork/Star Ratio | Ratio of forks to stars, indicating the project's popularity and engagement. |
The Reports Dashboard gives you a comprehensive view of the project's performance through four primary metrics. The dashboard utilizes intuitive data visualizations such as charts, graphs, and tables. These visual representations make it easier to interpret complex data and identify patterns.
The Reports Dashboard enables you to generate comprehensive reports based on the selected metrics and filters. These reports can be exported in various formats, such as PDF or CSV, making sharing the insights with team members or external stakeholders convenient.
At the core of the Reports Dashboard are the following four major metrics:
The Contributors Diversification metric in the Project Health dashboard provides insights into the distribution of contributions from individuals and organizations over time. This metric helps you understand how your project's contributor base is evolving and identify trends in contribution patterns.
The Individual Contributors chart displays the distribution of commits over time, broken down into three categories:
Total Commits: The total number of commits made by all contributors.
Top 21 Contributors: The top 21 contributors who have made the most commits.
All Others: The remaining contributors who have made commits, but are not in the top 21.
The chart shows the total commits percentage on the right Y-axis and the total number of commits on the left Y-axis, with time on the X-axis.
The Organization chart displays the distribution of commits over time, broken down into two categories:
Top Organizations: The top organizations that have made the most commits.
All Others: The remaining organizations that have made commits, but are not in the top organizations.
The chart shows the total commits percentage on the Y-axis and time on the X-axis.
By analyzing the charts, you can:
Identify trends in contributor activity over time.
Determine if the project's contributor base is becoming more or less diverse.
Identify top contributors and organizations, and understand their contribution patterns.
Use the metric to track changes in contributor activity over time.
Identify areas where the project may need more contributors or support.
Use the metric to inform decisions about project governance and contributor management.
The Project Health dashboard provides a comprehensive overview of your open source project's health and activity. It offers insights into key metrics such as contributor engagement, code quality, and issue tracking, allowing you to make data-driven decisions to improve your project's success. With the Project Health dashboard, you can:
Track contributor activity and identify trends in engagement
Monitor code quality and identify areas for improvement
Analyze issue tracking and resolve bottlenecks
Make informed decisions to drive project growth and success
By providing a clear and actionable view of your project's health, the Project Health dashboard empowers you to take control of your project's success and make a positive impact on the open source community.
The Contributors' reports provide insights into the individuals who have contributed to the project. This dashboard allows for the selection of data sources and provides specialized insights.
Select the project from the landing page or from the foundation page.
On the left navigation pane, click Reports>Contributors.
In the top-right corner, you will find the date filter option.
Click on the date filter to open a calendar.
Select the desired start and end dates for the data you want to analyze.
Click Apply to update the dashboard with the selected date range.
For more information, see Filter Date Range.
Locate the drop-down menu for data source selection.
Choose the desired data source from the available options.
The dashboard will update to display data specific to the selected source.
Currently, both GitHub and Git are selected as the data sources by default.
Locate the Display Only New Contributors toggle button.
Toggle it on to display data only for new contributors within the selected period.
Toggle it off to view data for all contributors.
Explore the Total Contributors chart section. When you toggle the New Contributors button, it displays the total new contributors.
Hover over the data points to view specific counts for that time.
Explore Active Contributors Today, Active Contributors This Week, or Active Contributors This Month charts. The Charts are date filter independent. They show real-time data
Click View to expand the list on the right side and see the list of contributors.
The chart shows new contributors when you toggle on the Display Only New Contributors Button.
Move to the "Active Contributors vs. Returning Contributors" chart.
click the drop-down to filter the data.
Understand the comparison between contributors who are active for the first time and those who have returned.
Navigate to the "Leaderboard" section.
You will find a list of the most active contributors.
Review their names and corresponding activity levels.