Skip to content

Commit fc23810

Browse files
Fixed typos in repository-setup.md (#894)
There were some typos, missing punctuation, and missing words. These changes should help clarify the instructions for users. Signed-off-by: Alex-Weisberg <[email protected]>
1 parent 2ddc4db commit fc23810

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

repository-setup.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Here are the steps involved in setting up a new repository; there is more information in the sections below.
44

5-
Step 1-3 should be performed by admin for the Kubeflow org
5+
Steps 1-3 should be performed by an admin for the Kubeflow org
66

77
1. Create the repository
88

@@ -13,9 +13,9 @@ Step 1-3 should be performed by admin for the Kubeflow org
1313
1. Create an OWNERS file at the root of the repository
1414

1515
* Anyone can create the PR
16-
* PR will need to be merged manually by Kubeflow org administrator
17-
* For more info on OWNERS files see [CONTRIBUTING.md](https://github.com/kubeflow/community/blob/master/CONTRIBUTING.md)
18-
* After the OWNERs file is merged subsequent PRs can be automatically merged by Tide
16+
* PR will need to be merged manually by a Kubeflow org administrator
17+
* For more info on OWNERS files, see [CONTRIBUTING.md](https://github.com/kubeflow/community/blob/master/CONTRIBUTING.md)
18+
* After the OWNERs file is merged, subsequent PRs can be automatically merged by Tide
1919

2020
1. Setup prow for the repository by following the instructions [below](#setup-prow)
2121

@@ -39,15 +39,15 @@ We use [Prow](https://github.com/kubernetes/test-infra)
3939

4040
1. Configure prow for the repository by following these [instructions](https://github.com/kubeflow/testing#setting-up-a-kubeflow-repository-to-use-prow-)
4141

42-
* Create a prow_config.yaml file with the following contents
42+
* Create a prow_config.yaml file with the following contents:
4343

4444
```
4545
workflows: []
4646
```
4747

48-
* This file is sufficient to ensure the prow jobs pass but doesn't run any actual tests.
48+
* This file is sufficient to ensure the prow jobs pass, but doesn't run any actual tests.
4949

50-
* When you are ready to actually add E2E tests you can follow [adding basic e2e tests](https://github.com/kubeflow/testing#adding-an-e2e-test-for-a-new-repository) to add a basic E2E test
50+
* When you are ready to actually add E2E tests, you can follow [adding basic e2e tests](https://github.com/kubeflow/testing#adding-an-e2e-test-for-a-new-repository) to add a basic E2E test
5151
for your repository
5252

5353
* See kubeflow/testing#11 for work creating generating tests for things like lint.
@@ -56,7 +56,7 @@ We use [Prow](https://github.com/kubernetes/test-infra)
5656
## Repository configuration
5757

5858
### Repository Permissions
59-
When setting up permissions for a repository there a few things to note:
59+
When setting up permissions for a repository there are a few things to note:
6060
- When providing permissions for `Collaborators and teams`, only teams should be used.
6161
- Teams that should be added by default, with write access, are `ci-bots` and `core-approvers`.
6262

@@ -69,15 +69,15 @@ Make sure to enable the third-party apps used by the Kubeflow community.
6969

7070
These apps include:
7171
- Reviewable
72-
- For Reviewable, sign in with Github and in the `Repositories` tab, make sure to allow visibility to your other orgs. After the allowing `Kubeflow` you should be able to enable your repo.
72+
- For Reviewable, sign in with Github and in the `Repositories` tab, make sure to allow visibility to your other orgs. After allowing `Kubeflow`, you should be able to enable your repo.
7373
- Click on the enabled repo in Reviewable and make sure to disable `Review status in GitHub PR` because this causes problems for prow https://github.com/kubernetes/test-infra/issues/7140
74-
- TravisCI
75-
- For TravisCI, any administrator of the repo should be able to enable tests. Just follow the TravisCI [Getting Started Guide](https://docs.travis-ci.com/user/getting-started/).
74+
- Travis CI
75+
- For Travis CI, any administrator of the repo should be able to enable tests. Just follow the Travis CI [Getting Started Guide](https://docs.travis-ci.com/user/getting-started/).
7676
- Coveralls
77-
- For instructions on enabling coveralls and integrating with travis, you can follow [these](https://docs.travis-ci.com/user/coveralls/) instructions. If you aren't an org admin, you may need to request assistance in enabling coveralls.
77+
- For instructions on enabling coveralls and integrating with Travis CI, you can follow [these](https://docs.travis-ci.com/user/coveralls/) instructions. If you aren't an org admin, you may need to request assistance in enabling coveralls.
7878

7979
### Branch Protections
80-
When setting up the repo, the `master` branch should be protected. Instructions on protection a branch can be found [here](https://help.github.com/articles/configuring-protected-branches/).
80+
When setting up the repo, the `master` branch should be protected. Instructions on protecting a branch can be found [here](https://help.github.com/articles/configuring-protected-branches/).
8181

8282
A few things to note when setting up branch protection:
8383
- Enable `Protect this branch` to protect the code in the `master` branch.

0 commit comments

Comments
 (0)