Updating some files of the documentation

Signed-off-by: Saksham Sharma <sakshamsharma630@gmail.com>
CharlesQQ · Jan 26, 2022 · 401c17e · 401c17e
1 parent 059b6c3
commit 401c17e
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 23 deletions.
diff --git a/GOVERNANCE.md b/GOVERNANCE.md
@@ -4,7 +4,7 @@
 
 The Volcano community adheres to the following principles:
 
-- Open: Volcano is open source community.
+- Open: Volcano is an open source community.
 - Welcoming and respectful: See [Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).
 - Transparent and accessible: Changes to the Volcano organization, Volcano code repositories, and CNCF related activities (e.g. level, involvement, etc) are done in public.
 - Merit: Ideas and contributions are accepted according to their technical merit and alignment with
@@ -38,7 +38,7 @@ or adhere to the [Code of Conduct](https://github.com/cncf/foundation/blob/maste
 
 ## Decision making process
 
-Decisions are build on consensus between maintainers.
+Decisions are built on consensus between maintainers.
 Proposals and ideas can either be submitted for agreement via a github issue or PR.
 
 In general, we prefer that technical issues and maintainer membership are amicably worked out between the persons involved.
@@ -87,4 +87,4 @@ The [Volcano Code of Conduct](https://github.com/cncf/foundation/blob/master/cod
 
 ## Credits
 
-Sections of this documents have been borrowed from [CoreDns](https://github.com/coredns/coredns/blob/master/GOVERNANCE.md).
+Sections of this document have been borrowed from [CoreDns](https://github.com/coredns/coredns/blob/master/GOVERNANCE.md).
diff --git a/SECURITY.md b/SECURITY.md
@@ -1,6 +1,6 @@
 # Security Release Process
 
-The Volcano project has adopted this security disclosures and response policy
+The Volcano project has adopted this security disclosure and response policy
 to ensure responsible handling of critical issues.
 
 

diff --git a/code_of_conduct.md b/code_of_conduct.md
@@ -3,7 +3,7 @@
 ## Our Pledge
 
 In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
+contributors and maintainers pledge to make participation in our project and
 our community a harassment-free experience for everyone, regardless of age, body
 size, disability, ethnicity, sex characteristics, gender identity and expression,
 level of experience, education, socio-economic status, nationality, personal

diff --git a/community-membership.md b/community-membership.md
@@ -18,7 +18,7 @@ This document gives a brief overview of the Volcano community roles with the req
 ## Member
 
 Members are active participants in the community who contribute by authoring PRs,
-reviewing issues/PRs or participate in community discussions on slack/mailing list.
+reviewing issues/PRs or participating in community discussions on slack/mailing list.
 
 
 ### Requirements
@@ -113,7 +113,7 @@ Has deep understanding of Volcano and related domain and facilitates major agree
 - Participate & Drive design/development of multiple features
 
 
-**Note :** These roles are applicable only for Volcano github organization and repositories. Currently Volcano doesn't have a formal process for review and acceptance into these roles. We will come-up with a process soon.
+**Note :** These roles are applicable only for Volcano github organization and repositories. Currently, Volcano doesn't have a formal process for review and acceptance into these roles. We will come-up with a process soon.
 
 
 [two-factor authentication]: https://help.github.com/articles/about-two-factor-authentication
diff --git a/contribute.md b/contribute.md
@@ -1,19 +1,21 @@
 
 # Welcome to Volcano!
 
--   [Before you get started](#before-you-get-started)
-    -   [Code of Conduct](#code-of-conduct)
-    -   [Community Expectations](#community-expectations)
--   [Getting started](#getting-started)
--   [Your First Contribution](#your-first-contribution)
-    -   [Find something to work on](#find-something-to-work-on)
-        -   [Find a good first topic](#find-a-good-first-topic)
-        -   [Work on an Issue](#work-on-an-issue)
-        -   [File an Issue](#file-an-issue)
--   [Contributor Workflow](#contributor-workflow)
-    -   [Creating Pull Requests](#creating-pull-requests)
-    -   [Code Review](#code-review)
-    -   [Testing](#testing)
+- [Welcome to Volcano!](#welcome-to-volcano)
+- [Before you get started](#before-you-get-started)
+  - [Code of Conduct](#code-of-conduct)
+  - [Community Expectations](#community-expectations)
+- [Getting started](#getting-started)
+- [Your First Contribution](#your-first-contribution)
+  - [Find something to work on](#find-something-to-work-on)
+    - [Find a good first topic](#find-a-good-first-topic)
+      - [Work on an issue](#work-on-an-issue)
+    - [File an Issue](#file-an-issue)
+- [Contributor Workflow](#contributor-workflow)
+  - [Creating Pull Requests](#creating-pull-requests)
+  - [Code Review](#code-review)
+    - [Format of the commit message](#format-of-the-commit-message)
+  - [Testing](#testing)
 
 # Before you get started
 
@@ -24,7 +26,7 @@ Please make sure to read and observe our [Code of Conduct](./code_of_conduct.md)
 ## Community Expectations
 
 Volcano is a community project driven by its community which strives to promote a healthy, friendly and productive environment.
-The goal of the community is to develop a volcano system which is useful for running high performance workloads such as AI, ML, Deep Learning Application on top of Kubernetes. To build a such volcano system at such scale requires the support of a community with similar aspirations.
+The goal of the community is to develop a volcano system which is useful for running high performance workloads such as AI, ML, Deep Learning Application on top of Kubernetes. To build such a volcano system at such scale requires the support of a community with similar aspirations.
 
 - See [Community Membership](./community-membership.md) for a list of various community roles. With gradual contributions, one can move up in the chain.
 
@@ -59,7 +61,7 @@ Another good way to contribute is to find a documentation improvement, such as a
 #### Work on an issue
 
 When you are willing to take on an issue, you can assign it to yourself. Just reply with `/assign` or `/assign @yourself` on an issue,
-then the robot will assign the issue to you and your name will present at `Assignees` list.
+then the robot will assign the issue to you and your name will be present on the `Assignees` list.
 
 ### File an Issue
 
@@ -111,7 +113,7 @@ The subject line should feature the what and the body of the commit should descr
 ```
 scripts: add test codes for metamanager
 
-this add some unit test codes to improve code coverage for metamanager
+this adds some unit test codes to improve code coverage for metamanager
 
 Fixes #12
 ```