Skip to content

Commit e214115

Browse files
authored
Merge pull request #1655 from hawksight/pf/prowing
docs: Add small into on prow to help potential new community members
2 parents 4104461 + 909f57b commit e214115

File tree

2 files changed

+27
-3
lines changed

2 files changed

+27
-3
lines changed

content/docs/contributing/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,3 +73,7 @@ Once you have access to Kubernetes Slack, you can search for and join the follow
7373

7474
- [`#cert-manager`](https://kubernetes.slack.com/messages/cert-manager): A channel for all users of cert-manager; use this for any usage-related questions.
7575
- [`#cert-manager-dev`](https://kubernetes.slack.com/messages/cert-manager-dev): Dedicated to collaboration between cert-manager contributors and maintainers. Please use this channel for code-related questions only.
76+
77+
## Issues and Pull Requests
78+
79+
If you are looking for help understanding our issue and pull request usage, then please review the [contributing flow](./contributing-flow.md) page.

content/docs/contributing/contributing-flow.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ Any issues towards the documentation should also be filed there.
1313
## GitHub bot
1414

1515
We use [Prow](https://github.com/k8s-ci-robot/test-infra/tree/master/prow) on all our repositories.
16-
If you've ever looked at a Kubernetes repo, you will probably already have met Prow. Prow will be able to help you in GitHub using its commands.
16+
If you've ever looked at a Kubernetes repo, you will probably already have met Prow.
17+
Prow will be able to help you in GitHub using its commands.
1718
You can find then all [on the command help page](https://prow.infra.cert-manager.io/command-help).
1819
Prow will also run all tests and assign certain labels on PRs.
1920

@@ -148,14 +149,33 @@ We brief our users/contributors about this in our bi-weekly community meeting, f
148149

149150
### Labels
150151

151-
We make a heavy use of GitHub labels for PRs and Issues. The ones on PRs are mostly managed by Prow and code reviewers.
152-
In issues we always aim to add 3 types: area, priority and kind. These are set using Prow using `/area`, `/kind` and `/priority`.
152+
We utilize GitHub labels for PRs and Issues. The ones on PRs are mostly managed by Prow and code reviewers.
153+
In issues we always aim to add 3 types: area, priority and kind.
154+
These are set using Prow using `/area`, `/kind` and `/priority`.
153155
Sometimes `/triage` is also added which helps us when following up Issues.
154156

155157
* Area indicates the code area which is/will need changing
156158
* Kind indicates if it is a `bug` or a `feature` but also can be `documentation` or `cleanup` (general maintenance)
157159
* Priority is the priority it has for the cert-manager team, PRs are still very welcome for those!
158160

161+
#### Good First Issues
162+
163+
Some Issues will be labeled with `good first issue`.
164+
This indicates we believe anyone should be able to have a go at this issue.
165+
This label is also manage via Prow. It can be assigned and unassigned as follows:
166+
167+
1. To label an issue as a "good first issue" a comment can be added to the issue as follows:
168+
169+
```text
170+
/good-first-issue
171+
```
172+
173+
2. To remove this label, comment with:
174+
175+
```text
176+
/remove-good-first-issue
177+
```
178+
159179
### Assignees meaning in PRs and issues
160180

161181
Sometimes, you might see someone commenting with the

0 commit comments

Comments
 (0)