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.

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

docs: remove typos from contributing file #449

Merged
merged 1 commit into from
Feb 22, 2023
Merged
Changes from all commits
Commits
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
19 changes: 11 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
# How about contributing to Vanus

Thanks for your focus on how to contribute to Vanus, we expect meet to you in Vanus Community. Any contributions including but
not only like submit issue/codebase/docs/tests/blogs are welcomed. Contributions to Vanus project are expected to adhere our
Thank you for focusing on how to contribute to Vanus, we expect to meet you in Vanus Community. All contributions including:
- submitting an issue
- reviewing the codebase for bugs
- writing documentations
- writing tests
- publishing blogpost about Vanus, are welcomed. Contributions to Vanus project are expected to adhere our
[Code of Conduct](CODE-OF-CONDUCT.md).

This document outlines some conventions about development workflow, commit message formatting, contact points and other
Expand Down Expand Up @@ -43,10 +47,10 @@ Vanus is a k8s based project.
Click [here](#) for details.

## Issues
After set up done, the next step is to choose an issue to address. Issues are all problems of Vanus that need to be addressed.
After set up is done, the next step is to choose an open issue to address. Issues are all problems of Vanus that need to be addressed.

### Choosing
You can find all issues in [vanus-issues](https://github.com/linkall-labs/vanus/issues) and choose one which isn't
You can find all open issues in [vanus-issues](https://github.com/linkall-labs/vanus/issues) and choose one which isn't
assigned to someone.

#### First Contribution
Expand All @@ -55,12 +59,11 @@ You can start by finding existing issues with the
These issues are well suited for a new contributor.

#### Further Contributions
After your first contribution was done, you cloud choose other issues you are interested in to continue contributing. You also
After your first contribution is done, you could choose other issues you are interested in to continue contributing. You also
could create a PR directly to Vanus for fixing or improving.

### Submit an Issue
Submitting an issue to Vanus is a pretty important contribution. Each issue whatever which about bug/feature request/improvement/
blog/looking for help/confusing is ESSENTIAL for making Vanus greater.
Submitting any issue to Vanus is an important contribution. All issues(bug, feature request, improvement, blog, looking for help, confusing, etc), is ESSENTIAL for making Vanus better.

You could click the `New issue` button in (issues sub-page)[https://github.com/linkall-labs/vanus/issues] of Vanus project to
submit an issue for us.
Expand All @@ -70,7 +73,7 @@ After your work is done, you can create a `Pull Request` by clicking the `New pu
[pull requests](https://github.com/linkall-labs/vanus/pulls) page to submit your contribution to Vanus.
More about `Pull Request` you can find [here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests).

There are some constraints that in order to save reviewer's time you need to pay attention to.
There are some constraints you need to pay attention to, in order to save reviewer's time.

### Style
We strictly check PR title's style. The PR's title follow [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/)
Expand Down