OpenMLDB
OpenMLDB copied to clipboard
documents about how to develop for developers
Describe the feature you'd like
Need documents about how to compile, test and deploy for developers
- we can add a
development.mdin docs/*/developer/, to summary all modules and development method - add the development guide entry in
CONTIRBUTING.mdfile - for each specific module
- we can put
READMEin each directory for a simple and quick introduction - any detail or advanced guide/usage, can appear in
docsdirectory, which also available in doc website
- we can put
- add the
Maintain.mdfor instruction like release workflow
Additional context
Add any other context or screenshots about the feature request here.
About development guide, we should add info about:
pr title, a lot of contributors write the wrong title. cicd: some workflow can be x, but some must be passed. And we should put the contribution-workflow in a more prominent position, first contributors need it.
agree, you can draft this and we can review together