This repository contains the data used in the OpenTR's State of Open Source Contribution in Turkey report.
Data from GitHub is collected using Cuttlecat and stored in the repository.
Later on, these data is processed and used to generate the report.
To see the report, visit https://state.opentr.foundation.
The report is constructed using multiple phases in 2 different repositories.
The data collection and processing is done in this repository.
The report generation is done in OpenTRFoundation/state-of-oss-contribution-report repository.
The src
folder contains the data collection scripts and cuttlecat
commands.
- 100-focus-project-candidate-search: Contains the data collected from GitHub using Cuttlecat for focus project candidates.
- 200-focus-project-extract: Contains the data extracted from the focus project candidates. This directory contains the focus organizations and focus repositories.
- 210-focus-organization-details: Contains the data collected from GitHub using Cuttlecat for focus organizations.
- 250-location-generation: Contains the location data (provinces and districts). This directory contains both the inputs and the outputs.
- 300-user-count-search: Contains the data collected from GitHub using Cuttlecat for user counts for locations.
- 400-user-and-contrib-search: Contains the data collected from GitHub using Cuttlecat for users and their contributions.
- 900-report-data-truthmap: This directory contains the truthmap data that's built using the data previously collected from GitHub.
- 910-debug-data: Similar to the truthmaps, this directory contains the debug data that's built using the data previously collected from GitHub. Contents of this directory are not used in the report, but they're for sanity checks.
- 990-report-data: This directory contains the data that's used in the report. This data is built using the truthmaps built earlier.
To see how the report works with the data prepared here, visit OpenTRFoundation/state-of-oss-contribution-report repository.
main
branch has the latest but unreleased data.
When a new release is ready, a new branch is created and the data is pushed to that branch. However, the report does not use the data from the main
branch. Instead, it uses the data from the tags.
To release a new version of the data, a new tag is created.
Tags follow <year>-<month>
format.
When there's new data ready for release, simply tag the commit and push the tag to the repository.