|
1 | 1 | # Contributing guidelines |
2 | 2 |
|
3 | | -The following is a set of guidelines for community contributions to this project. |
4 | | - |
5 | | -We really appreciate your desire to contribute! |
| 3 | +The following are a set of guidelines for contributing to this project. We appreciate your desire to get involved! |
6 | 4 |
|
7 | 5 | If you are an F5 employee, see the following additional guidance on [Maintainers etiquette](/documentation/maintainers-etiquette.md). |
8 | 6 |
|
9 | 7 | ## Table of contents |
10 | 8 |
|
11 | | -- [Report a Bug](#report-a-bug) |
12 | | -- [Suggest a Feature or Enhancement](#suggest-a-feature-or-enhancement) |
13 | | -- [Open a Discussion](#open-a-discussion) |
| 9 | +- [Create an issue](#create-an-issue) |
| 10 | +- [Start a discussion](#start-a-discussion) |
14 | 11 | - [Submit a pull request](#submit-a-pull-request) |
15 | | -- [Issue Lifecycle](#issue-lifecycle) |
| 12 | +- [Issue lifecycle](#issue-lifecycle) |
16 | 13 | - [Additional NGINX documentation](#additional-nginx-documentation) |
17 | 14 | - [F5 Contributor License Agreement (CLA)](#f5-contributor-license-agreement) |
18 | 15 |
|
19 | | -## Report a bug |
| 16 | +## Create an issue |
| 17 | + |
| 18 | +One way to contribute to the project is by [creating an issue](https://github.com/nginx/documentation/issues/new/choose). |
| 19 | + |
| 20 | +The two most common are enhancements and bug reports. When using the issue templates, they will be automatically labelled. |
| 21 | + |
| 22 | +- An enhancement is an improvement of some kind, such as a new document or additional detail for a product feature |
| 23 | +- A bug report draws attention to an issue in documentation, such as an incorrect command or outdated information |
20 | 24 |
|
21 | | -To report a bug, open an issue on GitHub with the label `bug` using the |
22 | | -available bug report issue template. Before reporting a bug, make sure the |
23 | | -issue has not already been reported. |
| 25 | +Before creating an issue, please check there is [no existing issue](https://github.com/nginx/documentation/issues?q=is%3Aissue) for the topic. |
24 | 26 |
|
25 | | -## Suggest a feature or enhancement |
| 27 | +We encourage discussions within issues, since they act as a source of contextual truth and are linked to pull requests. |
26 | 28 |
|
27 | | -To suggest a feature or enhancement, open an issue on GitHub with the label |
28 | | -`feature` or `enhancement` using the available feature request issue template. |
29 | | -Please ensure the feature or enhancement has not already been suggested. |
| 29 | +## Start a discussion |
30 | 30 |
|
31 | | -## Open a Discussion |
| 31 | +We encourage you to use [GitHub Discussions](https://github.com/nginx/documentation/discussions) for conversations with the community and maintainers. |
32 | 32 |
|
33 | | -If you want to start a conversation with the community and maintainers, |
34 | | -we encourage you to use |
35 | | -[GitHub Discussions](https://github.com/nginx/documentation/discussions). |
| 33 | +If you'd like to discuss something NGINX-related that doesn't involve documentation, you should go to the [NGINX Community Forum](https://community.nginx.org/). |
36 | 34 |
|
37 | 35 | ## Submit a pull request |
38 | 36 |
|
@@ -66,7 +64,6 @@ This repository does not include all of the source content for the NGINX documen |
66 | 64 | - [NGINX Open Source](https://github.com/nginx/nginx) - source for [NGINX changelog](https://nginx.org/en/CHANGES) |
67 | 65 | - [nginx.org](https://github.com/nginx/nginx.org) - source for https://nginx.org |
68 | 66 | - [NGINX Unit](https://github.com/nginx/unit) - source for https://unit.nginx.org |
69 | | -- [NGINX Ingress Controller](https://github.com/nginxinc/kubernetes-ingress/) - source for https://docs.nginx.com/nginx-ingress-controller |
70 | 67 |
|
71 | 68 | In those repositories, you can find documentation source code in the `docs` or `site` subdirectories. |
72 | 69 |
|
|
0 commit comments