4paradigm / 4paradigm/OpenMLDB

documents about how to develop for developers

Ouverte Adaptée aux débutants
#1,811 2 commentaires 1 réaction 1 personne assignée Réclamée par @aceforeverd Voir sur GitHub
documentation
Langage dominant
C++
Étoiles
1.7k
Forks
331
Merge moyen
12 j 12 h
PR mergées (30 j)
1

Description

**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.

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

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.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
markdown
Domaine
developer-experience, documentation
Type d'issue
Documentation
Difficulté
2/5
Temps estimé
1-3 heures
Activité
À l'abandon
Clarté
Clairement spécifiée
Accessibilité débutants
75/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.