Skip to content

Commit f8daa7c

Browse files
hadrien-tomahadrien-toma
committed
feat: add mermaid
1 parent fae4568 commit f8daa7c

File tree

22 files changed

+2305
-161
lines changed

22 files changed

+2305
-161
lines changed

‎FROM_EN_TO_FULL_FR.md‎

Lines changed: 488 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/contributing.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,31 @@ We welcome contributions in many forms:
167167
- Fill in the PR template
168168
- Submit for review
169169

170+
### Contribution Workflow Diagram
171+
172+
```mermaid
173+
graph TD
174+
A[Start: Fork Repository] --> B[Clone to Local]
175+
B --> C[Create Feature Branch]
176+
C --> D[Make Changes]
177+
D --> E[Test Locally]
178+
E --> F{Tests Pass?}
179+
F -->|No| D
180+
F -->|Yes| G[Commit Changes]
181+
G --> H[Push to GitHub]
182+
H --> I[Create Pull Request]
183+
I --> J[CI Tests Run]
184+
J --> K{Tests Pass?}
185+
K -->|No| L[Fix Issues]
186+
L --> D
187+
K -->|Yes| M[Code Review]
188+
M --> N{Approved?}
189+
N -->|Changes Requested| D
190+
N -->|Yes| O[Merge to Main]
191+
O --> P[Deploy to GitHub Pages]
192+
P --> Q[End: Contribution Complete]
193+
```
194+
170195
---
171196

172197
## Adding New Projects

‎docs/projects/fete_de_la_science/CONTRIBUTING.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# Contributing to Fête de la Science
22

3+
## Table of Contents
4+
5+
- [How to Contribute](#how-to-contribute)
6+
- [Ways to Contribute](#ways-to-contribute)
7+
- [Getting Started](#getting-started)
8+
- [Community Guidelines](#community-guidelines)
9+
- [Questions?](#questions)
10+
311
## How to Contribute
412

513
We welcome all SophiaHackLab members and community supporters to contribute to our Fête de la Science activities!

‎docs/projects/fete_de_la_science/README.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
# Fête de la Science
22

3+
## Table of Contents
4+
5+
- [Overview](#overview)
6+
- [Description](#description)
7+
- [Objectives](#objectives)
8+
- [Resources](#resources)
9+
310
## Overview
411

512
SophiaHackLab's participation in the Fête de la Science - an annual science festival celebrating scientific discovery and innovation.

‎docs/projects/fete_de_la_science/TODO.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
11
# Fête de la Science - TODO
22

3+
## Table of Contents
4+
5+
- [Pre-Event Planning](#pre-event-planning)
6+
- [High Priority](#high-priority)
7+
- [Medium Priority](#medium-priority)
8+
- [Low Priority](#low-priority)
9+
- [During Event](#during-event)
10+
- [Post-Event](#post-event)
11+
- [Completed Tasks](#completed-tasks)
12+
- [Notes](#notes)
13+
314
## Pre-Event Planning
415

516
### High Priority

‎docs/projects/rov/CONTRIBUTING.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,18 @@
11
# Contributing to ROV Project
22

3+
## Table of Contents
4+
5+
- [How to Contribute](#how-to-contribute)
6+
- [Ways to Contribute](#ways-to-contribute)
7+
- [Design & Engineering](#design--engineering)
8+
- [Software & Control](#software--control)
9+
- [Fabrication & Building](#fabrication--building)
10+
- [Documentation & Communication](#documentation--communication)
11+
- [Getting Started](#getting-started)
12+
- [Project Guidelines](#project-guidelines)
13+
- [Contact](#contact)
14+
- [Questions?](#questions)
15+
316
## How to Contribute
417

518
The ROV project welcomes contributors from all backgrounds - engineers, artists, scientists, and enthusiasts. Whether you're experienced or just curious, there's a place for you!

‎docs/projects/rov/README.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# ROV (Remotely Operated Vehicle)
22

3+
## Table of Contents
4+
5+
- [Overview](#overview)
6+
- [Description](#description)
7+
- [Project Goals](#project-goals)
8+
- [Technical Areas](#technical-areas)
9+
- [Resources](#resources)
10+
311
## Overview
412

513
SophiaHackLab's ROV project - building and programming remotely operated underwater vehicles.

‎docs/projects/rov/TODO.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,21 @@
11
# ROV Project - TODO
22

3+
## Table of Contents
4+
5+
- [Design Phase](#design-phase)
6+
- [High Priority](#high-priority)
7+
- [Medium Priority](#medium-priority)
8+
- [Low Priority](#low-priority)
9+
- [Build Phase](#build-phase)
10+
- [Mechanical](#mechanical)
11+
- [Electronics](#electronics)
12+
- [Software](#software)
13+
- [Testing Phase](#testing-phase)
14+
- [Documentation](#documentation)
15+
- [Completed Tasks](#completed-tasks)
16+
- [Notes](#notes)
17+
- [Future Ideas](#future-ideas)
18+
319
## Design Phase
420

521
### High Priority

‎docs/projects/triviak/mini/CONTRIBUTING.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# Contributing to Triviak Mini
22

3+
## Table of Contents
4+
5+
- [How to Contribute](#how-to-contribute)
6+
- [Getting Started](#getting-started)
7+
- [Code Standards](#code-standards)
8+
- [Reporting Issues](#reporting-issues)
9+
- [Questions?](#questions)
10+
311
## How to Contribute
412

513
We welcome contributions to Triviak Mini! Here's how you can help:

‎docs/projects/triviak/mini/README.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
# Triviak Mini
22

3+
## Table of Contents
4+
5+
- [Overview](#overview)
6+
- [Description](#description)
7+
- [Getting Started](#getting-started)
8+
- [Resources](#resources)
9+
310
## Overview
411

512
This is the Triviak Mini project documentation.

0 commit comments

Comments
 (0)