Add detailed development setup in Contributing docs

[Xuanwo]

We should add detailed development section in contributing docs so that developers can start building and playing with OpenDAL.

Guideline

• Every module should have it's own contributing docs which contains how to build and tests itself.
• Assume target readers don't know about any of rust/c/java/nodejs/python/...

Tasks

We should have following part:

• https://github.com/apache/incubator-opendal/blob/main/CONTRIBUTING.md
• bin
  • oay
  • oli
• bindings
  • c
  • java
  • https://github.com/apache/incubator-opendal/blob/main/bindings/nodejs/CONTRIBUTING.md
  • object_store
  • https://github.com/apache/incubator-opendal/blob/main/bindings/python/CONTRIBUTING.md
  • ruby

[suyanhanx]

We could update these relevant guidelines on our website and deploy more detailed documents under every reasonable directory they belong to.

[Gnosnay]

We may need to draft how raw API works in detail too.

[Xuanwo]

We may need to draft how raw API works in detail too.

No, not at the moment. I prefer to focus on delivering features in the current stage.

---

The Raw API is constantly undergoing refactoring, so it's not necessary to go into too much detail. We will gradually add detail docs for stable types such as Accessor or Builder. Most importantly, we should strive to maintain the clarity of our raw API. Developers should be able to understand its functionality without having to rely on comments.

[Gnosnay]

We may need to draft how raw API works in detail too.

No, not at the moment. I prefer to focus on delivering features in the current stage.

The Raw API is constantly undergoing refactoring, so it's not necessary to go into too much detail. We will gradually add detail docs for stable types such as Accessor or Builder. Most importantly, we should strive to maintain the clarity of our raw API. Developers should be able to understand its functionality without having to rely on comments.

true, if the code is clear enough to be treated as documentaion. thank you for reply

[xyjixyjixyji]

I think this could be a tracking issue, and maybe should have a format to be included.

For example, it could be something like:

Every doc should at least include

# Build xxx

## Dependencies

## Commands

# Test xxx
...

[Xuanwo]

Hi, I have added core/nodejs/python's contributing docs,would you like to take a look over c binding? We need to:

• Make sure our devcontainer can work out-of-box (via adding new deps).
• Add setup for binring your own box section
• Add build/test steps

[xyjixyjixyji]

Hi, I have added core/nodejs/python's contributing docs,would you like to take a look over c binding? We need to:

• Make sure our devcontainer can work out-of-box (via adding new deps).
• Add setup for binring your own box section
• Add build/test steps

Sure, I will have a look at this. But since I haven no experience of using devcontainer before, it may take some time for me to make sure that the documentation does not go wrong.

[Xuanwo]

Close for no actions to take, let's start new one if someone want to working on them.