You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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]>
Copy file name to clipboardExpand all lines: repository-setup.md
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
Here are the steps involved in setting up a new repository; there is more information in the sections below.
4
4
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
6
6
7
7
1. Create the repository
8
8
@@ -13,9 +13,9 @@ Step 1-3 should be performed by admin for the Kubeflow org
13
13
1. Create an OWNERS file at the root of the repository
14
14
15
15
* 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
19
19
20
20
1. Setup prow for the repository by following the instructions [below](#setup-prow)
21
21
@@ -39,15 +39,15 @@ We use [Prow](https://github.com/kubernetes/test-infra)
39
39
40
40
1. Configure prow for the repository by following these [instructions](https://github.com/kubeflow/testing#setting-up-a-kubeflow-repository-to-use-prow-)
41
41
42
-
* Create a prow_config.yaml file with the following contents
42
+
* Create a prow_config.yaml file with the following contents:
43
43
44
44
```
45
45
workflows: []
46
46
```
47
47
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.
49
49
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
51
51
for your repository
52
52
53
53
* 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)
56
56
## Repository configuration
57
57
58
58
### 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:
60
60
- When providing permissions for `Collaborators and teams`, only teams should be used.
61
61
- Teams that should be added by default, with write access, are `ci-bots` and `core-approvers`.
62
62
@@ -69,15 +69,15 @@ Make sure to enable the third-party apps used by the Kubeflow community.
69
69
70
70
These apps include:
71
71
- 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.
73
73
- 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/).
76
76
- 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.
78
78
79
79
### 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/).
81
81
82
82
A few things to note when setting up branch protection:
83
83
- Enable `Protect this branch` to protect the code in the `master` branch.
0 commit comments