Development

How to contribute through development

💾 Tech Stack

• GrimoireLab: Python, Vue.js, JavaScript/TypeScript, MySQL, Django, GraphQL.

• Augur: Python, Flask Vue.js, JavaScript/TypeScript, Jupyter.

✏ Technical Requirements

You'll need to have some basic programming experience with the technologies and tools we use.

Tools

Git & GitHub

Clone, commit and open a PR using Git and GitHub. Check out the following tutorials:

• Introduction to git

• Introduction to GitHub

• Popular git commands and how to use them

• Git commands in-depth

• Mastering Markdown

• Markdown Tutorial

• How to Write a Git Commit Message

Languages and Frameworks

Python

• Python's official tutorial

• Python's official style guide

• Python's best practices

• The Zen of Python

Flask

• Quickstart — Flask Documentation (2.0.x)

• Flask - Full Stack Python

Django

• Getting started with Django | Django

• Django Girls Tutorial

• Django - Full Stack Python

Vue.js

• Introduction — Vue.js

🏗 Project Structure

The CHAOSS community's projects have been divided in the following ways:

GrimoireLab

• chaoss / grimoirelab: The main repository for the GrimoireLab project, contains the information and details of all the tools.

• chaoss/grimoirelab-tutorial: Tutorial and guides for GrimoireLab.

• Data retrieval related components:

  • chaoss / grimoirelab-perceval: Retrieval of data from data sources.

  • chaoss / grimoirelab-graal: Source data analysis with external tools.

  • chaoss / grimoirelab-kingarthur: Batch processing for massive retrieval.

• Data enrichment related components:

  • chaoss / grimoirelab-elk: Storage and enrichment of data.

  • chaoss / grimoirelab-cereslib: Generic data processor.

  • chaoss / grimoirelab-sortinghat: Identity management.

• Data consumption related components:

  • chaoss / grimoirelab-kibiter: Dashboard, downstream version of Kibana.

  • chaoss / grimoirelab-sigils: Visualizations and dashboards.

  • chaoss / grimoirelab-kidash: Visualizations and dashboards manager.

  • chaoss / grimoirelab-manuscripts: Reporting.

• Platform management, orchestration, and common utils:

  • chaoss / grimoirelab-mordred: Orchestration.

  • chaoss / grimoirelab-toolkit: Common utilities.

  • chaoss / grimoirelab-bestiary: Web-based user interface to manage repositories and projects for Mordred.

Augur

• chaoss / augur: Augur is a tool for collecting and measuring structured data about free and open source (FOSS) communities.

• chaoss / augur-spdx: Augur's Open Source License coverage tool. Provides license identification by file, identification of non-OSI compliant licenses, and percentage of a project with license declarations.

• chaoss / augur-auggie: Auggie implementation utilizing Amazon Lex to classify messages.

• chaoss / augur-community-reports: A set of Jupyter Lab Notebooks and Other Implementations of Community Reports in Standard Form.

Cregit

• cregit / cregit: Cregit is a framework of tools that facilitates the analysis and visualization of the evolution of source code stored in git repositories.