Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc(dev-guide): note good first issue #19543

Merged
merged 2 commits into from
Nov 23, 2024
Merged

doc(dev-guide): note good first issue #19543

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
04718c2
doc(dev-guide): note good first issue
xxchan Nov 22, 2024
163091a
polish by gpt
xxchan Nov 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
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
View file
Open in desktop
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!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shall we also refer them to community slack?

### 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
Loading