Skip to content

Commit 1544dba

Browse files
committed
Add CI workflow and README
0 parents  commit 1544dba

File tree

2 files changed

+91
-0
lines changed

2 files changed

+91
-0
lines changed

.github/workflows/ci.yml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [main, develop]
6+
pull_request:
7+
branches: [main, develop]
8+
9+
jobs:
10+
test:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v4
14+
- name: Setup Rust
15+
uses: dtolnay/rust-toolchain@stable
16+
- name: Run tests
17+
run: cargo test
18+
19+
lint:
20+
runs-on: ubuntu-latest
21+
steps:
22+
- uses: actions/checkout@v4
23+
- name: Setup Rust
24+
uses: dtolnay/rust-toolchain@stable
25+
- name: Clippy
26+
run: cargo clippy -- -D warnings
27+
- name: Format
28+
run: cargo fmt --check

README.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# Git Reports
2+
3+
Generador de reportes automatizados para repositorios Git. Análisis de commits, contribuidores y métricas de actividad.
4+
5+
## 📋 Descripción
6+
7+
Git Reports es una herramienta construida en Rust que analiza repositorios Git y genera reportes automatizados con:
8+
- Estadísticas de commits por periodo
9+
- Análisis de contribuidores activos
10+
- Métricas de actividad y patrones
11+
- Exportación en múltiples formatos
12+
13+
## 🎯 Estado del Proyecto
14+
15+
**Milestone Actual**: 50% Complete
16+
17+
| Característica | Estado |
18+
|---------------|--------|
19+
| Análisis de commits ||
20+
| Métricas de contribuidores ||
21+
| Exportación de reportes | 🚧 WIP |
22+
| Visualización web | ⏳ Planificado |
23+
24+
## 🚀 Inicio Rápido
25+
26+
### Prerrequisitos
27+
28+
- Rust 1.70+
29+
- Cargo
30+
31+
### Instalación
32+
33+
```bash
34+
git clone https://github.com/madkoding/git-reports.git
35+
cd git-reports
36+
cargo build --release
37+
```
38+
39+
### Uso
40+
41+
```bash
42+
cargo run --release -- --repo /path/to/repo --output report.json
43+
```
44+
45+
## 🛠️ Stack Tecnológico
46+
47+
- **Lenguaje**: Rust
48+
- **Licencia**: MIT
49+
- **Tests**: 100% passing
50+
51+
## 📊 Métricas
52+
53+
![CI](https://img.shields.io/github/actions/workflow/status/madkoding/git-reports/ci.yml?label=CI&logo=github)
54+
![License](https://img.shields.io/github/license/madkoding/git-reports?logo=github)
55+
![Rust](https://img.shields.io/badge/rust-1.70+-DC2626?logo=rust&logoColor=white)
56+
57+
## 📄 Licencia
58+
59+
MIT - Ver [LICENSE](LICENSE) para detalles.
60+
61+
---
62+
63+
**Authored by**: [madkoding](https://github.com/madkoding)

0 commit comments

Comments
 (0)