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
+14-5Lines changed: 14 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -14,12 +14,15 @@ The following is a set of guidelines for contributing to the NGINX Plus Go Clien
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/nginx-plus-go-client/blob/main/CODE_OF_CONDUCT.md)
17
+
[Code of Conduct](CODE_OF_CONDUCT.md)
18
18
19
19
## Ask a Question
20
20
21
-
We will have a public forum soon where you can come and ask questions and have a discussion. For now please open an Issue on GitHub with the label `question`.
21
+
To ask a question please use [Github Discussions](https://github.com/nginxinc/nginx-plus-go-client/discussions).
22
22
23
+
You can also join our [Community Slack](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
26
24
27
## Getting Started
25
28
@@ -39,16 +42,22 @@ To suggest an enhancement, please create an issue on GitHub with the label `enha
39
42
### Open a Pull Request
40
43
41
44
* Fork the repo, create a branch, submit a PR when your changes are tested and ready for review
42
-
* You will be asked to fill in [our pull request template](.github/PULL_REQUEST_TEMPLATE.md)
45
+
* Fill in [our pull request template](.github/PULL_REQUEST_TEMPLATE.md)
46
+
47
+
> **Note**
48
+
>
49
+
> If you’d like to implement a new feature, please consider creating a feature request issue first to start a discussion about the feature.
50
+
51
+
### Issue lifecycle
43
52
44
-
Note: if you’d like to implement a new feature, please consider creating a feature request issue first to start a discussion about the feature.
53
+
* 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.
45
54
46
55
## Style Guides
47
56
48
57
### Git Style Guide
49
58
50
59
* Keep a clean, concise and meaningful git commit history on your branch, rebasing locally and squashing before submitting a PR
51
-
* 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
60
+
* 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
52
61
* In the subject line, use the present tense ("Add feature" not "Added feature")
53
62
* In the subject line, use the imperative mood ("Move cursor to..." not "Moves cursor to...")
To ensure a balance between work carried out by the NGINX engineering team while encouraging community involvement on this project, we use the following issue lifecycle. (Note: The issue *creator* refers to the community member that created the issue. The issue *owner* refers to the NGINX team member that is responsible for managing the issue lifecycle.)
4
+
5
+
1. New issue created by community member.
6
+
7
+
8
+
2. Assign issue owner: All new issues are assigned an owner on the NGINX engineering team. This owner shepherds the issue through the subsequent stages in the issue lifecycle.
9
+
10
+
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
+
#### 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.
14
+
15
+
`bug`: The implementation of a feature is not correct.
16
+
17
+
`proposal`: Request for a change. This can be a new feature, tackling technical debt, documentation changes, or improving existing features.
18
+
19
+
`question`: The owner converts the issue to a github discussion and engages the creator.
20
+
21
+
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
+
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.
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.
27
+
28
+
`backlog` issues can be labeled by the owner as `help wanted` and/or `good first issue` as appropriate.
29
+
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.
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:
0 commit comments