Skip to content

Commit e963fc0

Browse files
authored
Update labels, Issue Lifecycle and Contributing (#3553)
1 parent 84273d9 commit e963fc0

File tree

4 files changed

+46
-22
lines changed

4 files changed

+46
-22
lines changed

.github/labels.yml

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
- color: 77BC7C
2+
description: Pull requests/issues that are backlog items
3+
name: backlog
4+
- color: A90EA3
5+
description: Pull requests/issues that are candidates to be backlog items
6+
name: backlog candidate
17
- color: fc2929
28
description: An issue reporting a potential bug
39
name: bug
@@ -25,9 +31,24 @@
2531
- color: 16e2e2
2632
description: Pull requests that update Go code
2733
name: go
34+
- color: 5319E7
35+
description: Issues identified as good for first-time contributors
36+
name: good first issue
37+
- color: 0e8a16
38+
description: Pull requests that update the Helm Chart
39+
name: helm_chart
40+
- color: FBCA04
41+
description: Issues identified as good community contribution opportunities
42+
name: help wanted
2843
- color: c5def5
2944
description: Gathering information
30-
name: in_review
45+
name: in review
46+
- color: 68E39B
47+
description: Issues that require more information
48+
name: needs more info
49+
- color: F345AD
50+
description: Issues that are not in scope
51+
name: out of scope
3152
- color: db754c
3253
description: An issue that proposes a feature request
3354
name: proposal
@@ -39,7 +60,7 @@
3960
name: question
4061
- color: FEF2C0
4162
description: Pull requests that don't need to be added to the changelog
42-
name: skip-changelog
63+
name: skip changelog
4364
- color: 8E7888
4465
description: Pull requests/issues with no activity
4566
name: stale
@@ -52,6 +73,3 @@
5273
- color: ffffff
5374
description: An issue that does not need to be fixed
5475
name: wontfix
55-
- color: 0e8a16
56-
description: Pull requests that update the Helm Chart
57-
name: helm_chart

.github/release.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
changelog:
22
exclude:
33
labels:
4-
- skip-changelog
4+
- skip changelog
55
categories:
66
- title: 🚀 Features
77
labels:

CONTRIBUTING.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,15 @@ The following is a set of guidelines for contributing to the NGINX Ingress Contr
1414
* [Git Style Guide](#git-style-guide)
1515
* [Go Style Guide](#go-style-guide)
1616

17-
[Code of Conduct](https://github.com/nginxinc/kubernetes-ingress/blob/main/CODE_OF_CONDUCT.md)
17+
[Code of Conduct](CODE_OF_CONDUCT.md)
1818

1919
## Ask a Question
2020

2121
To ask a question please use [Github Discussions](https://github.com/nginxinc/kubernetes-ingress/discussions).
2222

23-
You can also join our [Community Slack channel](https://community.nginx.org/joinslack) which has a wider NGINX audience.
24-
25-
Please reserve Github issues for feature requests and bugs rather than general questions.
23+
You can also join our [Community Slack](https://community.nginx.org/joinslack) which has a wider NGINX audience.
2624

25+
Please reserve GitHub issues for feature requests and bugs rather than general questions.
2726

2827
## Getting Started
2928

@@ -37,9 +36,10 @@ Read the [documentation](https://github.com/nginxinc/kubernetes-ingress/tree/mai
3736
* The project follows a standard Go project layout
3837
* The main code is found at `cmd/nginx-ingress/`
3938
* The internal code is found at `internal/`
40-
* Build files for Docker and CI are found under `build/`
39+
* Build files for Docker are found at `build/`
40+
* CI files are found at `.github/workflows/`
4141
* Deployment yaml files, and Helm files are found at `deployments/`
42-
* The project dependencies are found at `vendor/`. We use [Go Modules](https://github.com/golang/go/wiki/Modules) for managing dependencies.
42+
* We use [Go modules](https://github.com/golang/go/wiki/Modules) for managing dependencies.
4343

4444
## Contributing
4545

@@ -55,16 +55,22 @@ To suggest an new feature or other improvement, create an issue on Github and ch
5555

5656
* Before working on a possible pull request, first open an associated issue describing the proposed change. This allows the core development team to discuss the potential pull request with you before you do the work.
5757
* Fork the repo, create a branch, submit a PR when your changes are tested and ready for review
58-
* Fill in [our pull request template](https://github.com/nginxinc/kubernetes-ingress/blob/main/.github/PULL_REQUEST_TEMPLATE.md)
58+
* Fill in [our pull request template](.github/PULL_REQUEST_TEMPLATE.md)
59+
60+
> **Note**
61+
>
62+
> Remember to create a feature request / bug report issue first to start a discussion about the proposed change.
63+
64+
### Issue lifecycle
5965

60-
**Note**: Remember to create a feature request / bug report issue first to start a discussion about the proposed change.
66+
* When an issue or PR is created, it will be triaged by the core development team and assigned a label to indicate the type of issue it is (bug, feature request, etc) and to determine the milestone. Please see the [Issue Lifecycle](ISSUE_LIFECYCLE.md) document for more information.
6167

6268
## Style Guides
6369

6470
### Git Style Guide
6571

6672
* Keep a clean, concise and meaningful git commit history on your branch, rebasing locally and squashing before submitting a PR
67-
* Follow the guidelines of writing a good commit message as described here https://chris.beams.io/posts/git-commit/ and summarised in the next few points
73+
* Follow the guidelines of writing a good commit message as described here https://chris.beams.io/posts/git-commit/ and summarized in the next few points
6874
* In the subject line, use the present tense ("Add feature" not "Added feature")
6975
* In the subject line, use the imperative mood ("Move cursor to..." not "Moves cursor to...")
7076
* Limit the subject line to 72 characters or less

ISSUE_LIFECYCLE.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ To ensure a balance between work carried out by the NGINX engineering team while
1010

1111
3. Determine issue type: This is done with automation where possible, and manually by the owner where necessary. The associated label is applied to the issue.
1212
#### Possible Issue Types
13-
`needs-more-info`: The owner should use the issue to request information from the creator. If we don't receive the needed information within 7 days automation closes the issue.
13+
`needs more info`: The owner should use the issue to request information from the creator. If we don't receive the needed information within 7 days, automation closes the issue.
1414

1515
`bug`: The implementation of a feature is not correct.
1616

@@ -21,17 +21,17 @@ To ensure a balance between work carried out by the NGINX engineering team while
2121

2222
4. Determine milestone: The owner, in collaboration with the wider team (PM & engineering), determines what milestone to attach to an issue. Generally, milestones correspond to product releases - however there are two 'magic' milestones with special meanings (not tied to a specific release):
2323

24-
- Issues assigned to backlog: Our team is in favour of implementing the feature request/fixing the issue, however the implementation is not yet assigned to a concrete release. If and when a `backlog` issue aligns well with our roadmap, it will be scheduled for a concrete iteration. We review and update our roadmap at least once every quarter. The `backlog` list helps us shape our roadmap, but it is not the only source of input. Therefore, some `backlog` items may eventually be closed as `out-of-scope`, or relabelled as `backlog-candidate` once it becomes clear that they do not align with our evolving roadmap.
24+
- Issues assigned to backlog: Our team is in favour of implementing the feature request/fixing the issue, however the implementation is not yet assigned to a concrete release. If and when a `backlog` issue aligns well with our roadmap, it will be scheduled for a concrete iteration. We review and update our roadmap at least once every quarter. The `backlog` list helps us shape our roadmap, but it is not the only source of input. Therefore, some `backlog` items may eventually be closed as `out of scope`, or relabelled as `backlog candidate` once it becomes clear that they do not align with our evolving roadmap.
2525

26-
- Issues assigned to `backlog-candidate`: Our team does not intend to implement the feature/fix request described in the issue and wants the community to weigh in before we make our final decision.
26+
- Issues assigned to `backlog candidate`: Our team does not intend to implement the feature/fix request described in the issue and wants the community to weigh in before we make our final decision.
2727

28-
`backlog` issues can be labeled by the owner as `help-wanted` and/or `good-first-issue` as appropriate.
28+
`backlog` issues can be labeled by the owner as `help wanted` and/or `good first issue` as appropriate.
2929

3030

31-
5. Promotion of `backlog-candidate` issue to `backlog` issue: If an issue labelled `backlog-candidate` receives more than 30 upvotes within 60 days, we promote the issue by applying the `backlog` label. While issues promoted in this manner have not been committed to a particular release, we welcome PRs from the community on them.
31+
5. Promotion of `backlog candidate` issue to `backlog` issue: If an issue labelled `backlog candidate` receives more than 30 upvotes within 60 days, we promote the issue by applying the `backlog` label. While issues promoted in this manner have not been committed to a particular release, we welcome PRs from the community on them.
3232

33-
If an issue does not make our roadmap and has not been moved to a discussion, it is closed with the label `out-of-scope`. The goal is to get every issue in the issues list to one of the following end states:
33+
If an issue does not make our roadmap and has not been moved to a discussion, it is closed with the label `out of scope`. The goal is to get every issue in the issues list to one of the following end states:
3434

3535
- An assigned release.
3636
- The `backlog` label.
37-
- Closed as `out-of-scope`.
37+
- Closed as `out of scope`.

0 commit comments

Comments
 (0)