Patterns for Documenting Open Source Frameworks

Requirements

• Python 3.6+
• Poetry

Installation

poetry install

Metrics:

1. Get events:

   poetry run python3 scripts/get_events.py --id 11730342 --owner vuejs --name vue

2. Standardize the events:

   poetry run python3 scripts/standardise_data.py --id 11730342 --owner vuejs --name vue

3. Calculate interpolation:

   poetry run python3 scripts/standardise_data.py --id 11730342 --owner vuejs --name vue

4. Join previous events with interpolated events:

   poetry run python3 scripts/join_files.py --id 11730342 --owner vuejs --name vue

Notes:

• Lower bound: Repository creation date
• Upper bound: 2021-04-30
• Step-value: 3 months.
• The final JSON files are located in /data/final/{repository_name}.json
• The data is downloaded from GH Archive

Visualization:

• The visualization notebooks (pattern adoption analysis and repository metrics) are located in /notebooks/.

Related documents:

• A Review of Pattern Languages for Software Documentation (EuroPLoP '20)
• Patterns for Documenting Open Source Frameworks (Thesis)
• Patterns for Documenting Open Source Frameworks (PLoP'21)