4paradigm / 4paradigm/OpenMLDB

documents about how to develop for developers

Aperta Adatta ai principianti
#1,811 2 commenti 1 reazione 1 assegnatario Rivendicata da @aceforeverd Vedi su GitHub
documentation
Lingua principale
C++
Stelle
1.7k
Fork
331
Merge medio
12g 12h
PR unite (30g)
1

Descrizione

**Describe the feature you'd like**

Need documents about how to compile, test and deploy for developers

- we can add a `development.md` in docs/*/developer/, to summary all modules and development method
- add the development guide entry in `CONTIRBUTING.md` file
- for each specific module
- we can put `README` in each directory for a simple and quick introduction
- any detail or advanced guide/usage, can appear in `docs` directory, which also available in doc website
- add the `Maintain.md` for instruction like release workflow

**Additional context**

Add any other context or screenshots about the feature request here.

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Look at the existing docs/*/developer/ directory and CONTRIBUTING.md to understand the current structure. The task involves creating a new development.md file summarizing modules and development methods, updating CONTRIBUTING.md to link to it, and possibly adding README files in module directories. Check the repository's root and docs layout to see where files should be placed.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
markdown
Ambito
developer-experience, documentation
Tipo di issue
Documentazione
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Specificata chiaramente
Idoneità per principianti
75/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.