You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pegasus.apache.org by la...@apache.org on 2021/06/03 09:49:00 UTC
[incubator-pegasus] 03/06: doc: Grammar fixes (#715)
This is an automated email from the ASF dual-hosted git repository.
laiyingchun pushed a commit to branch v2.2
in repository https://gitbox.apache.org/repos/asf/incubator-pegasus.git
commit 2b05c8d64f48eb34545ed694e31064d124b86f76
Author: fredster33 <64...@users.noreply.github.com>
AuthorDate: Tue Apr 6 21:00:00 2021 -0700
doc: Grammar fixes (#715)
---
.github/pull_request_template.md | 12 ++++++------
README.md | 12 ++++++------
2 files changed, 12 insertions(+), 12 deletions(-)
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index 3d32ccf..f061b78 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -1,32 +1,32 @@
### What problem does this PR solve? <!--add issue link with summary if exists-->
-### What is changed and how it works?
+### What is changed and how does it work?
-### Check List <!--REMOVE the items that are not applicable-->
+### Checklist <!--REMOVE the items that are not applicable-->
-Tests <!-- At least one of them must be included. -->
+##### Tests <!-- At least one of them must be included. -->
- Unit test
- Integration test
- Manual test (add detailed scripts or steps below)
- No code
-Code changes
+##### Code changes
- Has exported function/method change
- Has exported variable/fields change
- Has interface methods change
- Has persistent data change
-Side effects
+##### Side effects
- Possible performance regression
- Increased code complexity
- Breaking backward compatibility
-Related changes
+##### Related changes
- Need to cherry-pick to the release branch
- Need to update the documentation
diff --git a/README.md b/README.md
index cb83835..f5d5a62 100644
--- a/README.md
+++ b/README.md
@@ -11,8 +11,8 @@
[](https://www.apache.org/licenses/LICENSE-2.0.html)
[][github-release]
-**Note**: The `master` branch may be in an *unstable or even broken state* during development.
-Please use [releases][github-release] instead of the `master` branch in order to get stable binaries.
+**Note**: The `master` branch may be in an *unstable or even in a broken state* during development.
+Please use [GitHub Releases][github-release] instead of the `master` branch in order to get stable binaries.
Apache Pegasus is a distributed key-value storage system which is designed to be:
@@ -44,7 +44,7 @@ between data centers, automatic load balancing, and online partition split.
## To start using Pegasus
-See our documentation on [Pegasus Website][website].
+See our documentation on the [Pegasus Website][website].
## Client drivers
@@ -59,9 +59,9 @@ Pegasus has support for serveral languages:
## Contact us
-- Send mails to Apache Pegasus dev mailing list: dev@pegasus.apache.org. This is the place where topics around development, community, and problems are officially discussed. Please remember to subsribe the mail list via dev-subscribe@pegasus.apache.org.
+- Send emails to the Apache Pegasus developer mailing list: `dev@pegasus.apache.org`. This is the place where topics around development, community, and problems are officially discussed. Please remember to subscribe to the mailing list via `dev-subscribe@pegasus.apache.org`.
-- Github Issues: submit an issue when you have any idea to improve Pegasus, and when you encountered some bugs or problems.
+- GitHub Issues: submit an issue when you have any idea to improve Pegasus, and when you encountered some bugs or problems.
## Related Projects
@@ -80,4 +80,4 @@ Data import/export tools:
## License
Copyright 2020 The Apache Software Foundation. Licensed under the Apache License, Version 2.0:
-<http://www.apache.org/licenses/LICENSE-2.0>
+[http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@pegasus.apache.org
For additional commands, e-mail: commits-help@pegasus.apache.org