summaryrefslogtreecommitdiffhomepage
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorAlessandro Fael Garcia <alessfg@hotmail.com>2025-06-10 16:14:53 +0200
committerSergey Kandaurov <s.kandaurov@f5.com>2025-12-04 19:08:14 +0400
commit367113670ecda664074926e1ceb66fcef03972d1 (patch)
tree108901f7f93bd2fc6f9c9793dcba5e36bf6da03c /CONTRIBUTING.md
parentab4f5b2d32c1f621ebdf5816a34b568015b98c63 (diff)
downloadnginx-367113670ecda664074926e1ceb66fcef03972d1.tar.gz
nginx-367113670ecda664074926e1ceb66fcef03972d1.tar.bz2
Update GitHub templates and markdown files.
- Issue templates are replaced with forms. Forms allow to explicitly ask for certain info before an issue is opened, they can be programmatically queried via GH actions to get the data in fields. - Added language around GH discussions vs the forum in the issue forms. - Added GH discussions templates. These templates delineate which types of discussions belong on GitHub vs the community forum. - Created SUPPORT.md to delineate which types of topics belong on GitHub vs different support channels (community forum/docs/commercial support). - Updated CONTRIBUTING.md: - Removed text that belongs in SUPPORT.md. - Added F5 CLA clarifying text. - Added badges to README.md. Most of these are there to make information even clearer, moreso for users reading README.md from sources outside GitHub.
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md35
1 files changed, 24 insertions, 11 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 864e7989b..4436414f3 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -5,34 +5,34 @@ We really appreciate that you are considering contributing!
## Table of Contents
-- [Ask a Question](#ask-a-question)
- [Report a Bug](#report-a-bug)
- [Suggest a Feature or Enhancement](#suggest-a-feature-or-enhancement)
- [Open a Discussion](#open-a-discussion)
- [Submit a Pull Request](#submit-a-pull-request)
- [Issue Lifecycle](#issue-lifecycle)
-## Ask a Question
-
-To ask a question, open an issue on GitHub with the label `question`.
-
## Report a Bug
To report a bug, open an issue on GitHub with the label `bug` using the
-available bug report issue template. Before reporting a bug, make sure the
-issue has not already been reported.
+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).**
## Suggest a Feature or Enhancement
-To suggest a feature or enhancement, open an issue on GitHub with the label
-`feature` or `enhancement` using the available feature request issue template.
+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.
## Open a Discussion
If you want to engage in a conversation with the community and maintainers,
we encourage you to use
-[GitHub Discussions](https://github.com/nginx/nginx/discussions).
+[GitHub Discussions](https://github.com/nginx/nginx/discussions) to discuss
+the NGINX codebase or the [NGINX Community forum](https://community.nginx.org)
+to chat anything else NGINX (including troubleshooting).
## Submit a Pull Request
@@ -89,7 +89,20 @@ git clone https://github.com/nginx/nginx-tests.git
```
- Submitting a change implies granting project a permission to use it under the
-[BSD-2-Clause license](https://github.com/nginx/nginx/blob/master/LICENSE)
+[BSD-2-Clause license](/LICENSE)
+
+### F5 Contributor License Agreement (CLA)
+
+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!).
+
+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.
## Issue Lifecycle