From 082a3cbe3b7f6c28630f271c74b1787220974ed9 Mon Sep 17 00:00:00 2001 From: Maryna Herasimovich Date: Thu, 29 Aug 2024 13:06:48 -0700 Subject: [PATCH] Added GitHub templates. --- .github/ISSUE_TEMPLATE/bug_report.md | 38 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 18 +++++++++++ .github/pull_request_template.md | 10 ++++++ 3 files changed, 66 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 000000000..efdc1167f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,38 @@ +--- +name: Bug report +about: Create a report to help us improve +title: "" +labels: "bug" +--- + +### Environment + +Include the result of the following commands: + - `nginx -V` + - `uname -a` + +### Description + +Describe the bug in full detail including expected and actual behavior. +Specify conditions that caused it. Provide the relevant part of nginx +configuration and debug log. + +- [ ] The bug is reproducible with the latest version of nginx +- [ ] The nginx configuration is minimized to the smallest possible +to reproduce the issue and doesn't contain third-party modules + +#### nginx configuration + +``` +# Your nginx configuration here +``` +or share the configuration in [gist](https://gist.github.com/). + +#### nginx debug log + +It is advised to enable +[debug logging](http://nginx.org/en/docs/debugging_log.html). +``` +# Your nginx debug log here +``` +or share the debug log in [gist](https://gist.github.com/). diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 000000000..67471b083 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,18 @@ +--- +name: Feature request +about: Suggest a feature for nginx +title: "" +labels: "feature" +--- + +### Describe the feature you'd like to add to nginx + +A clear and concise description of the feature. + +### Describe the problem this feature solves + +A clear and concise description of the problem. + +### Additional context + +Add any other context about the feature request here. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..0ee1fc364 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,10 @@ +### Proposed changes + +Describe the use case and detail of the change. + +If this pull request addresses an issue on GitHub, make sure to reference that +issue using one of the +[supported keywords](https://docs.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue). + +Before creating a pull request, make sure to comply with +[`Contributing Guidelines`](/CONTRIBUTING.md).