OpenMLDB icon indicating copy to clipboard operation
OpenMLDB copied to clipboard

documents about how to develop for developers

Open aceforeverd opened this issue 3 years ago • 2 comments

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.

aceforeverd avatar May 12 '22 15:05 aceforeverd

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.

vagetablechicken avatar May 21 '22 04:05 vagetablechicken

agree, you can draft this and we can review together

lumianph avatar May 21 '22 09:05 lumianph