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
The following is a set of guidelines for contributing to this project. We really appreciate that you are considering
4
-
contributing!
3
+
The following is a set of guidelines for contributing to this project. We really appreciate that you are considering contributing!
5
4
6
5
#### Table Of Contents
7
6
@@ -15,57 +14,42 @@ contributing!
15
14
16
15
## Getting Started
17
16
18
-
Refer to the [Getting Started Guide](docs/getting_started.md) for how to build
19
-
and run the gateway.
17
+
Refer to the [Getting Started Guide](docs/getting_started.md) for how to build and run the gateway.
20
18
21
19
## Contributing
22
20
23
21
### Report a Bug
24
22
25
-
To report a bug, open an issue on GitHub with the label `bug` using the available bug report issue template. Please
26
-
ensure the bug has not already been reported. **If the bug is a potential security vulnerability, please report it using
27
-
our [security policy](/SECURITY.md).**
23
+
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 it using our [security policy](/SECURITY.md).**
28
24
29
25
### Suggest a Feature or Enhancement
30
26
31
-
To suggest a feature or enhancement, please create an issue on GitHub with the label `enhancement` using the
32
-
available [feature request template](/.github/feature_request_template.md). Please ensure the feature or enhancement has
33
-
not already been suggested.
27
+
To suggest a feature or enhancement, please create an issue on GitHub with the label `enhancement` using the available [feature request template](/.github/feature_request_template.md). Please ensure the feature or enhancement has not already been suggested.
34
28
35
29
### Open a Pull Request (PR)
36
30
37
-
- Fork the repo, create a branch, implement your changes, add any relevant tests, and submit a PR when your changes are
38
-
**tested** and ready for review.
31
+
- 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.
39
32
- Fill in the [PR template](/.github/pull_request_template.md).
40
33
41
-
**Note:** If you'd like to implement a new feature, please consider creating
42
-
a [feature request issue](/.github/feature_request_template.md) first to start a discussion about the feature.
34
+
**Note:** If you'd like to implement a new feature, please consider creating a [feature request issue](/.github/feature_request_template.md) first to start a discussion about the feature.
43
35
44
36
#### F5 Contributor License Agreement (CLA)
45
37
46
-
F5 requires all external contributors to agree to the terms of the F5 CLA (
47
-
available [here](https://github.com/f5/.github/blob/main/CLA/cla-markdown.md)) before any of their changes can be
48
-
incorporated into an F5 Open Source repository.
38
+
F5 requires all external contributors to agree to the terms of the F5 CLA (available [here](https://github.com/f5/.github/blob/main/CLA/cla-markdown.md)) before any of their changes can be incorporated into an F5 Open Source repository.
49
39
50
-
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
51
-
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
52
-
can be merged. Your agreement signature will be safely stored by F5 and no longer be required in future PRs.
40
+
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.
- Keep a clean, concise and meaningful git commit history on your branch (within reason), rebasing locally and squashing
61
-
before submitting a PR.
62
-
- If possible and/or relevant, use the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) format
63
-
when writing a commit message, so that changelogs can be automatically generated.
64
-
- Follow the guidelines of writing a good commit message as described here <https://chris.beams.io/posts/git-commit/>
65
-
and summarized in the next few points:
66
-
- In the subject line, use the present tense ("Add feature" not "Added feature").
67
-
- In the subject line, use the imperative mood ("Move cursor to..." not "Moves cursor to...").
68
-
- Limit the subject line to 72 characters or less.
69
-
- Reference issues and pull requests liberally after the subject line.
70
-
- Add more detailed description in the body of the git message (`git commit -a` to give you more space and time in
71
-
your text editor to write a good message instead of `git commit -am`).
48
+
- Keep a clean, concise and meaningful git commit history on your branch (within reason), rebasing locally and squashing before submitting a PR.
49
+
- 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.
50
+
- 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:
51
+
- In the subject line, use the present tense ("Add feature" not "Added feature").
52
+
- In the subject line, use the imperative mood ("Move cursor to..." not "Moves cursor to...").
53
+
- Limit the subject line to 72 characters or less.
54
+
- Reference issues and pull requests liberally after the subject line.
55
+
- 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`).
Copy file name to clipboardExpand all lines: SUPPORT.md
+7-16Lines changed: 7 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,39 +4,30 @@
4
4
5
5
We use GitHub for tracking bugs and feature requests related to this project.
6
6
7
-
Don't know how something in this project works? Curious if this project can achieve your desired functionality? Please
8
-
open an issue on GitHub with the label `question`. Alternatively, start a GitHub discussion!
7
+
Don't know how something in this project works? Curious if this project can achieve your desired functionality? Please open an issue on GitHub with the label `question`. Alternatively, start a GitHub discussion!
9
8
10
9
## NGINX Specific Questions and/or Issues
11
10
12
-
This isn't the right place to get support for NGINX specific questions, but the following resources are available below.
13
-
Thanks for your understanding!
11
+
This isn't the right place to get support for NGINX specific questions, but the following resources are available below. Thanks for your understanding!
14
12
15
13
### Community Forum
16
14
17
-
We have a community [forum](https://community.nginx.org/)! If you have any questions and/or issues, try checking out
18
-
the [`Troubleshooting`](https://community.nginx.org/c/troubleshooting/8) and [
19
-
`How do I...?`](https://community.nginx.org/c/how-do-i/9) categories. Both fellow community members and NGINXers might
20
-
be able to help you! :)
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! :)
21
16
22
17
### Documentation
23
18
24
19
For a comprehensive list of all NGINX directives, check out <https://nginx.org>.
25
20
26
-
For a comprehensive list of administration and deployment guides for all NGINX products, check
27
-
out <https://docs.nginx.com>.
21
+
For a comprehensive list of administration and deployment guides for all NGINX products, check out <https://docs.nginx.com>.
28
22
29
23
### Mailing List
30
24
31
-
Want to get in touch with the NGINX development team directly? Try using the relevant mailing list found
32
-
at <https://mailman.nginx.org/mailman3/lists/>!
25
+
Want to get in touch with the NGINX development team directly? Try using the relevant mailing list found at <https://mailman.nginx.org/mailman3/lists/>!
33
26
34
27
## Contributing
35
28
36
-
Please see the [contributing guide](/CONTRIBUTING.md) or the [Getting Started](/README.md#getting-started) guide, for
37
-
guidelines on how to best contribute to this project.
29
+
Please see the [contributing guide](/CONTRIBUTING.md) or the [Getting Started](/README.md#getting-started) guide, for guidelines on how to best contribute to this project.
38
30
39
31
## Community Support
40
32
41
-
This project does **not** offer commercial support. Community support is offered on a best effort basis through either
42
-
GitHub issues/PRs/discussions or through any of our active communities.
33
+
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