InseeFrLab / InseeFrLab/auto-tuning-vllm

Add core docs: README, CONTRIBUTING, Roadmap

Open
#6 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
6
Forks
0
Avg merge
34m
Merged PRs (30d)
2

Description

### Description

The repo is missing basic documentation. We need a minimal setup so people can understand the project and contribute without friction.

### Tasks

* **README.md**

* what the project does / why it exists
* quickstart (install + example)
* link to roadmap + contributing
* clarify relation to upstream (since this is a fork)

* **CONTRIBUTING.md**

* how to run the project locally
* branch naming (`feat/`, `fix/`, etc.)
* PR expectations (small, clear, tests if relevant)
* commit style (`feat:`, `fix:`, `docs:`…)

* **Roadmap**

* simple structure: Now / Next / Later
* main priorities (stability, CI, tests, core features)

### Done when

* README is enough to get started quickly
* CONTRIBUTING is usable without asking questions
* roadmap is visible and clear
* links between docs are consistent

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.