Tools used to manage and evaluate the Hyperledger Community
This lab will contain tools that can be used to manage and evaluate the Hyperledger Community, including:
- project reporting tools
- contributor statistic tools
- contributor diversity tools
All tools will be documented fully so that anyone in the community can run them. In addition, all tools will contain a --help
option to provide help from the command line.
These tools currently only work for the Hyperledger and Hyperledger Labs GitHub organizations as they utilize the list of repositories as defined in ./common/repositories.sh
.
- get_contributors - generates a comma-separated file containing a list of contributors.
- get_lines_of_code - generates a comma-separated file containing a list of repositories, the number of files, and the lines of code.
- create_tarballs - creates tarballs of the latest source in the specified repositories
- repo_structure - provides a report about how a project lines up with the common repository structure.
- signed_off_by_audit - creates a list of contributors who landed change sets without the 'Signed-off-by' tag from all source repositories (as defined in
../common/repositories.sh
).
These tools should work for any GitHub organization as they either use the GitHub GraphQL API or are designed to take a configuration file for specifying what you wish to report on.
- Project Reports - generates a health assessment report for each project within Hyperledger, as well as other projects that might be of interest.
- Project Report Requirements specifies the proposed content
- Project Report README provides details on how to run
- list-old-repos - creates a list of repositories for a specified organization where the last commit on the main branch is older than a specified date.
- org-dashboard - generates a markdown dashboard showing information about GitHub repositories for a specified organization
- org-repo-info - generates a JSON file containing information for a specified organization