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: docs/developer/implementing-a-feature.md
+11-11Lines changed: 11 additions & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -17,19 +17,21 @@ practices to ensure a successful feature development process.
17
17
the [branching and workflow](/docs/developer/branching-and-workflow.md) documentation.
18
18
4.**Branch**: Create a branch following
19
19
the [naming conventions](/docs/developer/branching-and-workflow.md#branch-naming-conventions).
20
-
5.**Make changes**: Make the necessary changes for the feature.
21
-
6.**Consider opening a draft PR**: If your feature involves substantial architecture changes, or you would like to
20
+
5.**Review style guide** Review the [Go style guide](/docs/developer/go-style-guide.md) to familiarize yourself with
21
+
the project's coding practices.
22
+
6.**Make changes**: Make the necessary changes for the feature.
23
+
7.**Consider opening a draft PR**: If your feature involves substantial architecture changes, or you would like to
22
24
receive early feedback, consider opening a draft PR and requesting reviews from the maintainers. Draft PRs are an
23
25
effective means to solicit feedback and ensure that major architectural changes align with the project's goals and
24
26
standards.
25
-
7.**Add or update unit tests** All features **must** be accompanied by unit tests that verify the functionality. Make
27
+
8.**Add or update unit tests** All features **must** be accompanied by unit tests that verify the functionality. Make
26
28
sure to thoroughly test the different scenarios and edge cases related to the feature to ensure robustness and
27
29
reliability. Additionally, open the code coverage report to ensure that the code you added has sufficient test
28
30
coverage. For instructions on writing and running unit tests, refer to
29
31
the [testing](/docs/developer/testing.md#unit-test-guidelines) documentation.
30
-
8.**Manually verify your changes**: Refer to the [manual testing](/docs/developer/testing.md#manual-testing) section of
32
+
9.**Manually verify your changes**: Refer to the [manual testing](/docs/developer/testing.md#manual-testing) section of
31
33
the testing documentation for instructions on how to manually test your changes.
32
-
9.**Update any relevant documentation**: Here are some guidelines for updating documentation:
34
+
10.**Update any relevant documentation**: Here are some guidelines for updating documentation:
33
35
-**Gateway API Feature**: If you are implementing a Gateway API feature, make sure to update
34
36
the [Gateway API Compatibility](/docs/gateway-api-compatibility.md) documentation.
35
37
-**New Use Case:** If your feature introduces a new use case, add an example of how to use it in
@@ -41,22 +43,20 @@ practices to ensure a successful feature development process.
41
43
-**Other Documentation Updates**: For any other changes that affect the behavior, usage, or configuration of NKG,
42
44
review the existing documentation and update it as necessary. Ensure that the documentation remains accurate and
43
45
up to date with the latest changes.
44
-
10.**Lint code**: See the [run the linter](/docs/developer/quickstart.md#run-the-linter) section of the quickstart
46
+
11.**Lint code**: See the [run the linter](/docs/developer/quickstart.md#run-the-linter) section of the quickstart
45
47
guide for instructions.
46
-
11.**Open pull request**: Open a pull request targeting the `main` branch of
48
+
12.**Open pull request**: Open a pull request targeting the `main` branch of
47
49
the [nginx-kubernetes-gateway](https://github.com/nginxinc/nginx-kubernetes-gateway/tree/main) repository. The
48
50
entire `nginx-kubernetes-gateway` group will be automatically requested for review. If you have a specific or
49
51
different reviewer in mind, you can request them as well. Refer to
50
52
the [pull request](/docs/developer/pull-request.md) documentation for expectations and guidelines.
51
-
12.**Obtain the necessary approvals**: Work with code reviewers to maintain the required number of approvals.
52
-
13.**Squash and merge**: Squash your commits locally, or use the GitHub UI to squash and merge. Only one commit per
53
+
13.**Obtain the necessary approvals**: Work with code reviewers to maintain the required number of approvals.
54
+
14.**Squash and merge**: Squash your commits locally, or use the GitHub UI to squash and merge. Only one commit per
53
55
pull request should be merged. Make sure the first line of the final commit message includes the pull request
54
56
number. For example, Fix supported gateway conditions in compatibility doc (#674).
55
57
> **Note**:
56
58
When you squash commits, make sure to not include any commit messages related to the code review
57
59
(for example, Fixed a typo). If you changed the code as a result of the code review in way that the original commit message no longer describes it well, make sure to update the message.
0 commit comments