]> git.kaiwu.me - njs.git/commitdiff
Added issue templates.
authorDmitry Volyntsev <xeioex@nginx.com>
Thu, 30 May 2024 00:04:27 +0000 (17:04 -0700)
committerDmitry Volyntsev <xeioexception@gmail.com>
Thu, 30 May 2024 03:11:17 +0000 (20:11 -0700)
.github/ISSUE_TEMPLATE/bug_report.md [new file with mode: 0644]
.github/ISSUE_TEMPLATE/feature_request.md [new file with mode: 0644]
.github/pull_request_template.md [new file with mode: 0644]

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644 (file)
index 0000000..7104840
--- /dev/null
@@ -0,0 +1,52 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ""
+labels: "bug"
+---
+
+### Describe the bug
+
+A clear and concise description of what the bug is.
+Before submitting a bug report, please check the following:
+
+- [ ] The bug is reproducible with the latest version of njs.
+- [ ] I minimized the code and NGINX configuration to the smallest
+possible to reproduce the issue.
+
+### To reproduce
+
+Steps to reproduce the behavior:
+
+- JS script
+```js
+// Your JS code here
+```
+or put the code in a [gist](https://gist.github.com/) and link it here.
+- NGINX configuration if applicable
+```
+# Your NGINX configuration here
+```
+or put the configuration in a [gist](https://gist.github.com/) and link it here.
+- NGINX logs if applicable
+```
+# Your NGINX logs here
+```
+or post the full log to a [gist](https://gist.github.com/) and link it here.
+- Output of the `nginx -V` command if applicable.
+- Exact steps to reproduce the behavior
+
+### Expected behavior
+
+A clear and concise description of what you expected to happen.
+
+### Your environment
+
+- Version of njs or specific commit
+- Version of NGINX if applicable
+- List of other enabled nginx modules if applicable
+- OS: [e.g. Ubuntu 20.04]
+
+### Additional context
+
+Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644 (file)
index 0000000..19b5d25
--- /dev/null
@@ -0,0 +1,22 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ""
+labels: "feature"
+---
+
+### Is your feature request related to a problem? Please describe
+
+A clear and concise description of what the problem is.
+
+### Describe the solution you'd like
+
+A clear and concise description of what you want to happen.
+
+### Describe alternatives you've considered
+
+A clear and concise description of any alternative solutions or features you've considered.
+
+### Additional context
+
+Add any other context or screenshots about the feature request here.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644 (file)
index 0000000..3c54896
--- /dev/null
@@ -0,0 +1,10 @@
+### Proposed changes
+
+Describe the use case and detail of the change. If this PR addresses an issue on GitHub, make sure to include a link to 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) here in this description (not in the title of the PR).
+
+### Checklist
+
+Before creating a PR, run through this checklist and mark each as complete:
+- [ ] I have read the [`CONTRIBUTING`](CONTRIBUTING.md) document
+- [ ] If applicable, I have added tests that prove my fix is effective or that my feature works
+- [ ] If applicable, I have checked that any relevant tests pass after adding my changes