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
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+15-9Lines changed: 15 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,16 +14,15 @@ The following is a set of guidelines for contributing to the NGINX Ingress Contr
14
14
*[Git Style Guide](#git-style-guide)
15
15
*[Go Style Guide](#go-style-guide)
16
16
17
-
[Code of Conduct](https://github.com/nginxinc/kubernetes-ingress/blob/main/CODE_OF_CONDUCT.md)
17
+
[Code of Conduct](CODE_OF_CONDUCT.md)
18
18
19
19
## Ask a Question
20
20
21
21
To ask a question please use [Github Discussions](https://github.com/nginxinc/kubernetes-ingress/discussions).
22
22
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.
26
24
25
+
Please reserve GitHub issues for feature requests and bugs rather than general questions.
27
26
28
27
## Getting Started
29
28
@@ -37,9 +36,10 @@ Read the [documentation](https://github.com/nginxinc/kubernetes-ingress/tree/mai
37
36
* The project follows a standard Go project layout
38
37
* The main code is found at `cmd/nginx-ingress/`
39
38
* 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/`
41
41
* 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.
43
43
44
44
## Contributing
45
45
@@ -55,16 +55,22 @@ To suggest an new feature or other improvement, create an issue on Github and ch
55
55
56
56
* 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.
57
57
* 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
59
65
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.
61
67
62
68
## Style Guides
63
69
64
70
### Git Style Guide
65
71
66
72
* 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
68
74
* In the subject line, use the present tense ("Add feature" not "Added feature")
69
75
* In the subject line, use the imperative mood ("Move cursor to..." not "Moves cursor to...")
Copy file name to clipboardExpand all lines: ISSUE_LIFECYCLE.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ To ensure a balance between work carried out by the NGINX engineering team while
10
10
11
11
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.
12
12
#### 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
+
`needsmoreinfo`: 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.
14
14
15
15
`bug`: The implementation of a feature is not correct.
16
16
@@ -21,17 +21,17 @@ To ensure a balance between work carried out by the NGINX engineering team while
21
21
22
22
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):
23
23
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 `backlogcandidate` once it becomes clear that they do not align with our evolving roadmap.
25
25
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 `backlogcandidate`: 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.
27
27
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 `helpwanted` and/or `goodfirstissue` as appropriate.
29
29
30
30
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 `backlogcandidate` issue to `backlog` issue: If an issue labelled `backlogcandidate` 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.
32
32
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:
0 commit comments