Skip to content

Commit 7616750

Browse files
alessfgalessfg
authored
feat: Split forms into distinct project & template forms (#159)
1 parent d2ccec0 commit 7616750

7 files changed

Lines changed: 116 additions & 7 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ body:
1414
1515
**Note:** If you are seeking community support, please start a new topic in the [NGINX Community forum][forum]. If you wish to discuss the codebase, please start a new thread via [GitHub discussions][discussions].
1616
17-
[issue search]: https://github.com/{{REPOSITORY_OWNER}}/{{REPOSITORY_URL}}/search?q=is%3Aissue&type=issues
18-
[discussions]: https://github.com/{{REPOSITORY_OWNER}}/{{REPOSITORY_URL}}/discussions
17+
[issue search]: https://github.com/nginx/template-repository/search?q=is%3Aissue&type=issues
18+
[discussions]: https://github.com/nginx/template-repository/discussions
1919
[forum]: https://community.nginx.org
2020
2121
- type: textarea

‎.github/ISSUE_TEMPLATE/bug_report.yml.template‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
name: 🐛 Bug report
3+
description: Create a report to help us improve
4+
labels: bug
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this bug report!
10+
11+
Before you continue filling out this report, please take a moment to check that your bug has not been [already reported on GitHub][issue search] 🙌
12+
13+
Remember to redact any sensitive information such as authentication credentials and/or license keys!
14+
15+
**Note:** If you are seeking community support, please start a new topic in the [NGINX Community forum][forum]. If you wish to discuss the codebase, please start a new thread via [GitHub discussions][discussions].
16+
17+
[issue search]: https://github.com/{{REPOSITORY_OWNER}}/{{REPOSITORY_URL}}/search?q=is%3Aissue&type=issues
18+
[discussions]: https://github.com/{{REPOSITORY_OWNER}}/{{REPOSITORY_URL}}/discussions
19+
[forum]: https://community.nginx.org
20+
21+
- type: textarea
22+
id: overview
23+
attributes:
24+
label: Bug Overview
25+
description: A clear and concise overview of the bug.
26+
placeholder: When I do "X", "Y" happens instead of "Z".
27+
validations:
28+
required: true
29+
30+
- type: textarea
31+
id: behavior
32+
attributes:
33+
label: Expected Behavior
34+
description: A clear and concise description of what you expected to happen.
35+
placeholder: When I do "X", I expect "Z" to happen.
36+
validations:
37+
required: true
38+
39+
- type: textarea
40+
id: steps
41+
attributes:
42+
label: Steps to Reproduce the Bug
43+
description: Detail the series of steps required to reproduce the bug.
44+
placeholder: When I run "X" using [...], "X" fails with "Y" error message. If I check the terminal outputs and/or logs, I see the following info.
45+
validations:
46+
required: true
47+
48+
- type: textarea
49+
id: environment
50+
attributes:
51+
label: Environment Details
52+
description: Please provide details about your environment.
53+
value: |
54+
- Target deployment platform: [e.g. AWS/GCP/local cluster/etc...]
55+
- Target OS: [e.g. RHEL 9/Ubuntu 24.04/etc...]
56+
- Version of this project or specific commit: [e.g. 1.4.3/commit hash]
57+
- Version of any relevant project languages: [e.g. Kubernetes 1.30/Python 3.9.7/etc...]
58+
validations:
59+
required: true
60+
61+
- type: textarea
62+
id: context
63+
attributes:
64+
label: Additional Context
65+
description: Add any other context about the problem here.
66+
placeholder: Feel free to add any other context/information/screenshots/etc... that you think might be relevant to this issue in here.

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ body:
1212
1313
**Note:** If you are seeking community support, please start a new topic in the [NGINX Community forum][forum]. If you wish to discuss the codebase, please start a new thread via [GitHub discussions][discussions].
1414
15-
[issue search]: https://github.com/{{REPOSITORY_OWNER}}/{{REPOSITORY_URL}}/search?q=is%3Aissue&type=issues
16-
[discussions]: https://github.com/{{REPOSITORY_OWNER}}/{{REPOSITORY_URL}}/discussions
15+
[issue search]: https://github.com/nginx/template-repository/search?q=is%3Aissue&type=issues
16+
[discussions]: https://github.com/nginx/template-repository/discussions
1717
[forum]: https://community.nginx.org
1818
1919
- type: textarea

‎.github/ISSUE_TEMPLATE/feature_request.yml.template‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
name: ✨ Feature request
3+
description: Suggest an idea for this project
4+
labels: enhancement
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this feature request!
10+
11+
Before you continue filling out this request, please take a moment to check that your feature has not been [already requested on GitHub][issue search] 🙌
12+
13+
**Note:** If you are seeking community support, please start a new topic in the [NGINX Community forum][forum]. If you wish to discuss the codebase, please start a new thread via [GitHub discussions][discussions].
14+
15+
[issue search]: https://github.com/{{REPOSITORY_OWNER}}/{{REPOSITORY_URL}}/search?q=is%3Aissue&type=issues
16+
[discussions]: https://github.com/{{REPOSITORY_OWNER}}/{{REPOSITORY_URL}}/discussions
17+
[forum]: https://community.nginx.org
18+
19+
- type: textarea
20+
id: overview
21+
attributes:
22+
label: Feature Overview
23+
description: A clear and concise description of what the feature request is.
24+
placeholder: I would like this project to be able to do "X".
25+
validations:
26+
required: true
27+
28+
- type: textarea
29+
id: alternatives
30+
attributes:
31+
label: Alternatives Considered
32+
description: Detail any potential alternative solutions/workarounds you've used or considered.
33+
placeholder: I have done/might be able to do "X" in this project by doing "Y".
34+
35+
- type: textarea
36+
id: context
37+
attributes:
38+
label: Additional Context
39+
description: Add any other context about the problem here.
40+
placeholder: Feel free to add any other context/information/screenshots/etc... that you think might be relevant to this feature request here.

.github/dependabot.yml.inactive renamed to .github/dependabot.yml.template

File renamed without changes.

‎.github/pull_request_template.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ Describe the use case and detail of the change. If this PR addresses an issue on
66

77
Before creating a PR, run through this checklist and mark each as complete:
88

9-
- [ ] I have read the [contributing guidelines](https://github.com/{{REPOSITORY_OWNER}}/{{REPOSITORY_URL}}/CONTRIBUTING.md).
9+
- [ ] I have read the [contributing guidelines](/CONTRIBUTING.md).
1010
- [ ] I have signed the [F5 Contributor License Agreement (CLA)](https://github.com/f5/f5-cla/blob/main/docs/f5_cla.md).
1111
- [ ] If applicable, I have added tests that prove my fix is effective or that my feature works.
1212
- [ ] If applicable, I have checked that any relevant tests pass after adding my changes.
13-
- [ ] I have updated any relevant documentation ([`README.md`](https://github.com/{{REPOSITORY_OWNER}}/{{REPOSITORY_URL}}/README.md) and/or [`CHANGELOG.md`](https://github.com/{{REPOSITORY_OWNER}}/{{REPOSITORY_URL}}/CHANGELOG.md)).
13+
- [ ] I have updated any relevant documentation ([`README.md`](/README.md) and/or [`CHANGELOG.md`](/CHANGELOG.md)).

‎.github/workflows/scripts/rename_project.sh‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,15 @@ rm -f .github/scorecard.yml
3434
if [[ "$GITHUB_REPOSITORY_OWNER" != "devcentral" && "$GITHUB_REPOSITORY_OWNER" != "f5" && "$GITHUB_REPOSITORY_OWNER" != "f5networks" && "$GITHUB_REPOSITORY_OWNER" != "nginx" && "$GITHUB_REPOSITORY_OWNER" != "nginxinc" ]]; then
3535
rm -f .github/workflows/f5_cla.yml
3636
fi
37+
# Replace project issue forms with the templated issue forms (filled by sed above)
38+
mv -f .github/ISSUE_TEMPLATE/bug_report.yml.template .github/ISSUE_TEMPLATE/bug_report.yml
39+
mv -f .github/ISSUE_TEMPLATE/feature_request.yml.template .github/ISSUE_TEMPLATE/feature_request.yml
3740
# Remove the template instructions from the README and the template's CHANGELOG
3841
sed -i '1,/^---$/ { /^$/d; d }' README.md
3942
sed -i '1,/^---$/ { /^$/d; d }' CHANGELOG.md
4043
# Remove Renovatebot and activate Dependabot
4144
rm -f .github/renovate.json
42-
mv .github/dependabot.yml.inactive .github/dependabot.yml
45+
mv .github/dependabot.yml.template .github/dependabot.yml
4346
# Remove this script and the GitHub Action workflow using this script
4447
rm -f .github/workflows/rename_template.yml
4548
rm -rf .github/workflows/scripts

0 commit comments

Comments
 (0)