Skip to content

Commit

Permalink
doc(dev-guide): note good first issue (#19543)
Browse files Browse the repository at this point in the history
Signed-off-by: xxchan <xxchan22f@gmail.com>
  • Loading branch information
xxchan authored Nov 23, 2024
1 parent 236e761 commit b4bca57
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 4 deletions.
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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
11 changes: 10 additions & 1 deletion docs/dev/src/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,21 @@ To report bugs, create a [GitHub issue](https://github.com/risingwavelabs/rising

<!-- toc -->

## 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:
Expand All @@ -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
Expand Down

0 comments on commit b4bca57

Please sign in to comment.