You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@opendal.apache.org by xu...@apache.org on 2023/04/30 13:34:41 UTC
[incubator-opendal] 01/01: docs: Merge DEVELOPING into CONTRIBUTING
This is an automated email from the ASF dual-hosted git repository.
xuanwo pushed a commit to branch polish-contributing
in repository https://gitbox.apache.org/repos/asf/incubator-opendal.git
commit 748440b481bd937beacce2192f2ba151ebd092ed
Author: Xuanwo <gi...@xuanwo.io>
AuthorDate: Sun Apr 30 21:34:23 2023 +0800
docs: Merge DEVELOPING into CONTRIBUTING
Signed-off-by: Xuanwo <gi...@xuanwo.io>
---
CONTRIBUTING.md | 39 +++++++++++++++++++++++++++++++++++++--
DEVELOPING.md | 19 -------------------
core/CONTRIBUTING.md | 4 ----
3 files changed, 37 insertions(+), 25 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index f6f997fb..da4632b0 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -10,7 +10,9 @@ First, thank you for contributing to OpenDAL! The goal of this document is to pr
- [Reviews & Approvals](#reviews--approvals)
- [Merge Style](#merge-style)
- [CI](#ci)
-- [Next steps](#next-steps)
+- [Setup](#setup)
+ - [Using a devcontainer environment](#using-a-devcontainer-environment)
+ - [Bring your own toolbox](#bring-your-own-toolbox)
- [Code of Conduct](#code-of-conduct)
## Your First Contribution
@@ -59,7 +61,40 @@ Currently, OpenDAL uses GitHub Actions to run tests. The workflows are defined i
## Next steps
-Visiting **[DEVELOPING.md](DEVELOPING.md)** to prepare everything necessary to develop.
+## Setup
+
+For small or first-time contributions, we recommend the dev container method. Prefer to do it yourself? That's fine too!
+
+### Using a devcontainer environment
+
+OpenDAL provides a pre-configured [dev container](https://containers.dev/) that could be used in [Github Codespaces](https://github.com/features/codespaces), [VSCode](https://code.visualstudio.com/), [JetBrains](https://www.jetbrains.com/remote-development/gateway/), [JuptyerLab](https://jupyterlab.readthedocs.io/en/stable/). Please pick up your favourite runtime environment.
+
+The fastest way is:
+
+[](https://codespaces.new/apache/incubator-opendal?quickstart=1&machine=standardLinux32gb)
+
+### Bring your own toolbox
+
+OpenDAL is primarily a Rust project. To build OpenDAL, you will need to set up Rust development first. We highly recommend using [rustup](https://rustup.rs/) for the setup process.
+
+For Linux or MacOS, use the following command:
+
+```shell
+curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
+```
+
+For Windows, download `rustup-init.exe` from [here](https://win.rustup.rs/x86_64) instead.
+
+Rustup will read OpenDAL's `rust-toolchain.toml` and set up everything else automatically. To ensure that everything works correctly, run `cargo version` under OpenDAL's root directory:
+
+```shell
+:) cargo version
+cargo 1.69.0 (6e9a83356 2023-04-12)
+```
+
+Some components may require specific setup steps. Please refer to their respective `CONTRIBUTING` documentation for more details.
+
+- [core](core/CONTRIBUTING.md)
## Code of Conduct
diff --git a/DEVELOPING.md b/DEVELOPING.md
deleted file mode 100644
index d7adbbc5..00000000
--- a/DEVELOPING.md
+++ /dev/null
@@ -1,19 +0,0 @@
-# Developing
-
-- [Setup](#setup)
- - [Using a devcontainer environment](#using-a-devcontainer-environment)
- - [Bring your own toolbox](#bring-your-own-toolbox)
-
-## Setup
-
-We're super excited to have you interested in working on OpenDAL! Before you start you should pick how you want to develop.
-
-For small or first-time contributions, we recommend the dev container method. Prefer to do it yourself? That's fine too!
-
-### Using a devcontainer environment
-
-OpenDAL provides a pre-configured [dev container](https://containers.dev/) that could be used in [Github Codespaces](https://github.com/features/codespaces), [VSCode](https://code.visualstudio.com/), [JetBrains](https://www.jetbrains.com/remote-development/gateway/), [JuptyerLab](https://jupyterlab.readthedocs.io/en/stable/). Please pick up your favourite runtime environment.
-
-The fastest way is:
-
-[](https://codespaces.new/apache/incubator-opendal?quickstart=1&machine=standardLinux32gb)
diff --git a/core/CONTRIBUTING.md b/core/CONTRIBUTING.md
index ba252ae9..1976a6c6 100644
--- a/core/CONTRIBUTING.md
+++ b/core/CONTRIBUTING.md
@@ -2,10 +2,6 @@
## Get Started
-This is a Rust project, so [rustup](https://rustup.rs/) is the best place to start.
-
-This is a pure rust project, so only `cargo` is needed.
-
- `cargo check` to analyze the current package and report errors.
- `cargo build` to compile the current package.
- `cargo clippy` to catch common mistakes and improve code.