From b4bca5724e7acb9c39919aaa188ed699a10eb1f4 Mon Sep 17 00:00:00 2001 From: xxchan Date: Sat, 23 Nov 2024 16:16:36 +0800 Subject: [PATCH] doc(dev-guide): note good first issue (#19543) Signed-off-by: xxchan --- CONTRIBUTING.md | 6 +++--- docs/dev/src/contributing.md | 11 ++++++++++- 2 files changed, 13 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7403b83afb698..5f305d85d07fb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,7 +1,7 @@ # Contributing to RisingWave -Contributing documentation has moved to the **[RisingWave Developer Guide](https://risingwavelabs.github.io/risingwave/)**. - +Read the **[RisingWave Developer Guide](https://risingwavelabs.github.io/risingwave/)** for +how to develop and contribute to RisingWave. ## Before hacking on RisingWave @@ -13,4 +13,4 @@ Please read [the process] of how to submit your change to RisingWave. [Community Slack]: https://risingwave.com/slack [file an issue]: https://github.com/risingwavelabs/risingwave/issues/new/choose -[the process]: https://risingwavelabs.github.io/risingwave/contribution +[the process]: https://risingwavelabs.github.io/risingwave/contributing.html diff --git a/docs/dev/src/contributing.md b/docs/dev/src/contributing.md index 38d8b8cc77c33..926138795d617 100644 --- a/docs/dev/src/contributing.md +++ b/docs/dev/src/contributing.md @@ -11,12 +11,21 @@ To report bugs, create a [GitHub issue](https://github.com/risingwavelabs/rising +## Find Something to Work On + +Issues labeled with [ `good first issue` ](https://github.com/risingwavelabs/risingwave/contribute) are suitable for new RisingWave hackers. +They are relatively easy to begin with and can guide you getting familiar with one module of RisingWave. + ## Tests and miscellaneous checks Before submitting your code changes, ensure you fully test them and perform necessary checks. The testing instructions and necessary checks are detailed in other sections of the book. ## Submit a PR +### Ask for Review + +To get your PR reviewed and merged sooner, you can find and `@` mention developers who recently worked on the same files. If you're not sure who to ask, feel free to reach out to any active developers to help find relevant reviewers. Don't hesitate to follow up politely if you haven't received a response, or ask for help in the RisingWave Community Slack channel. We welcome you to be proactive in finding reviewers for your PR! + ### Pull Request title As described in [here](https://github.com/commitizen/conventional-commit-types/blob/master/index.json), a valid PR title should begin with one of the following prefixes: @@ -28,7 +37,7 @@ As described in [here](https://github.com/commitizen/conventional-commit-types/b - `style`: A refactoring that improves code style - `perf`: A code change that improves performance - `test`: Adding missing tests or correcting existing tests -- `build`: Changes that affect the build system or external dependencies (example scopes: `.config`, `.cargo`, `Cargo.toml`) +- `build`: Changes that affect the build system or external dependencies (example scopes: `.config`, `.cargo`, `Cargo.toml`) - `ci`: Changes to RisingWave CI configuration files and scripts (example scopes: `.github`, `ci` (Buildkite)) - `chore`: Other changes that don't modify src or test files - `revert`: Reverts a previous commit