Skip to content

Commit 879b63f

Browse files
committed
NLB-6740 Updated the SUPPORT and CONTRIBUTING guides
1 parent 04cfa00 commit 879b63f

File tree

2 files changed

+33
-20
lines changed

2 files changed

+33
-20
lines changed

CONTRIBUTING.md

Lines changed: 25 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
The following is a set of guidelines for contributing to the nginx_loadbalancer_kubernetes. We really appreciate that you are considering contributing!
44

5-
#### Table Of Contents
5+
## Table Of Contents
66

77
[Getting Started](#getting-started)
88

@@ -24,24 +24,37 @@ We are not currently accepting contributions to this project. Please create an i
2424

2525
### Report a Bug
2626

27-
To report a bug, open an issue on GitHub with the label `bug` using the available bug report issue template. Please ensure the bug has not already been reported. **If the bug is a potential security vulnerability, please report using our security policy.**
27+
To report a bug, open an issue on GitHub with the label `bug` using the available [bug report issue form](/.github/ISSUE_TEMPLATE/bug_report.yml). Please ensure the bug has not already been reported. **If the bug is a potential security vulnerability, please report it using our [security policy](/SECURITY.md).**
2828

2929
### Suggest a Feature or Enhancement
3030

31-
To suggest a feature or enhancement, please create an issue on GitHub with the label `feature` or `enhancement` using the available feature request issue template. Please ensure the feature or enhancement has not already been suggested.
31+
To suggest a feature or enhancement, please create an issue on GitHub with the label `enhancement` using the available [feature request issue form](/.github/ISSUE_TEMPLATE/feature_request.yml). Please ensure the feature or enhancement has not already been suggested.
32+
33+
### Open a Pull Request (PR)
34+
35+
- Fork the repo, create a branch, implement your changes, add any relevant tests, and submit a PR when your changes are **tested** and ready for review.
36+
- Fill in the [PR template](/.github/pull_request_template.md).
37+
38+
> [!NOTE]
39+
> If you'd like to implement a new feature, please consider creating a [feature request issue](/.github/ISSUE_TEMPLATE/feature_request.yml) first to start a discussion about the feature.
40+
41+
#### F5 Contributor License Agreement (CLA)
42+
43+
F5 requires all contributors to agree to the terms of the F5 CLA (available [here](https://github.com/f5/f5-cla/blob/main/docs/f5_cla.md)) before any of their changes can be incorporated into an F5 Open Source repository (even contributions to the F5 CLA itself!).
44+
45+
If you have not yet agreed to the F5 CLA terms and submit a PR to this repository, a bot will prompt you to view and agree to the F5 CLA. You will have to agree to the F5 CLA terms through a comment in the PR before any of your changes can be merged. Your agreement signature will be safely stored by F5 and no longer be required in future PRs.
3246

3347
## Code Guidelines
3448

3549
<!-- ### Go/Python/Bash Guidelines (OPTIONAL) -->
3650

3751
### Git Guidelines
3852

39-
* Keep a clean, concise and meaningful git commit history on your branch (within reason), rebasing locally and squashing before submitting a PR.
40-
* If possible and/or relevant, use the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) format when writing a commit message, so that changelogs can be automatically generated
41-
* 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:
42-
* In the subject line, use the present tense ("Add feature" not "Added feature").
43-
* In the subject line, use the imperative mood ("Move cursor to..." not "Moves cursor to...").
44-
* Limit the subject line to 67 characters or less.
45-
* Limit the rest of the commit message to 72 characters or less.
46-
* Reference issues and pull requests liberally after the subject line.
47-
* Add more detailed description in the body of the git message (`git commit -a` to give you more space and time in your text editor to write a good message instead of `git commit -am`).
53+
- Keep a clean, concise and meaningful git commit history on your branch (within reason), rebasing locally and squashing before submitting a PR.
54+
- If possible and/or relevant, use the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) format when writing a commit message, so that changelogs can be automatically generated.
55+
- 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:
56+
- In the subject line, use the present tense ("Add feature" not "Added feature").
57+
- In the subject line, use the imperative mood ("Move cursor to..." not "Moves cursor to...").
58+
- Limit the subject line to 72 characters or less.
59+
- Reference issues and pull requests liberally after the subject line.
60+
- Add more detailed description in the body of the git message (`git commit -a` to give you more space and time in your text editor to write a good message instead of `git commit -am`).

SUPPORT.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,20 +10,20 @@ Don't know how something in the nginx_loadbalancer_kubernetes works? Curious if
1010

1111
This isn't the right place to get support for NGINX specific questions, but the following resources are available below. Thanks for your understanding!
1212

13-
### Community Slack
13+
### Community Forum
1414

15-
We have a community [Slack](https://nginxcommunity.slack.com/)!
16-
17-
If you are not a member click [here](https://join.slack.com/t/nginxcommunity/shared_invite/zt-1aaa22w80-~_~wSMNyPxLPLp5xunOC7w) to sign up (and let us know if the link does not seem to be working!)
18-
19-
Once you join, check out the `#beginner-questions` and `nginx-users` channels :)
15+
We have a community [forum](https://community.nginx.org/)! If you have any questions and/or issues, try checking out the [`Troubleshooting`](https://community.nginx.org/c/troubleshooting/8) and [`How do I...?`](https://community.nginx.org/c/how-do-i/9) categories. Both fellow community members and NGINXers might be able to help you! :)
2016

2117
### Documentation
2218

2319
For a comprehensive list of all NGINX directives, check out <https://nginx.org>.
2420

2521
For a comprehensive list of admin and deployment guides for all NGINX products, check out <https://docs.nginx.com>.
2622

27-
### Mailing List
23+
## Contributing
24+
25+
Please see the [contributing guide](/CONTRIBUTING.md) for guidelines on how to best contribute to this project.
26+
27+
## Community Support
2828

29-
Want to get in touch with the NGINX dev team directly? Try using the relevant mailing list found at <https://mailman.nginx.org/mailman3/lists/>!
29+
This project does **not** offer commercial support. Community support is offered on a best effort basis through either GitHub issues/PRs/discussions or through any of our active communities.

0 commit comments

Comments
 (0)