Skip to content

Commit 92a4bad

Browse files
committed
chore: update comm files and workflows for org migration
1 parent 0ab2f81 commit 92a4bad

File tree

9 files changed

+193
-108
lines changed

9 files changed

+193
-108
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 41 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
---
2+
name: 🐛 Bug report
3+
description: Create a report to help us improve
4+
labels:
5+
- bug
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for taking the time to fill out this bug report!
11+
12+
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] 🙌
13+
14+
Remember to redact any sensitive information such as authentication credentials and/or license keys!
15+
16+
**Note:** If you are seeking community support or have a question, please consider starting a new thread via [GitHub discussions][discussions] or the [NGINX Community forum][forum].
17+
18+
[issue search]: ../search?q=is%3Aissue&type=issues
19+
20+
[discussions]: ../discussions
21+
[forum]: https://community.nginx.org
22+
23+
- type: textarea
24+
id: overview
25+
attributes:
26+
label: Bug Overview
27+
description: A clear and concise overview of the bug.
28+
placeholder: When I do "X", "Y" happens instead of "Z".
29+
validations:
30+
required: true
31+
32+
- type: textarea
33+
id: behavior
34+
attributes:
35+
label: Expected Behavior
36+
description: A clear and concise description of what you expected to happen.
37+
placeholder: When I do "X", I expect "Z" to happen.
38+
validations:
39+
required: true
40+
41+
- type: textarea
42+
id: steps
43+
attributes:
44+
label: Steps to Reproduce the Bug
45+
description: Detail the series of steps required to reproduce the bug.
46+
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.
47+
validations:
48+
required: true
49+
50+
- type: textarea
51+
id: environment
52+
attributes:
53+
label: Environment Details
54+
description: Please provide details about your environment.
55+
value: |
56+
- Version of the S3 container used (when downloaded from either Docker Hub or the GitHub Container Registry)
57+
- Version of this project or specific commit when building your own S3 container
58+
- Version of NGINX Open Source or NGINX Plus (OSS/Plus)
59+
- Version of NGINX JavaScript
60+
- Target deployment platform for the S3 container
61+
- S3 backend implementation (AWS, Ceph, NetApp StorageGrid, etc...)
62+
- Authentication method (IAM, IAM with Fargate, IAM with K8S, AWS Credentials, etc...)
63+
validations:
64+
required: true
65+
66+
- type: textarea
67+
id: context
68+
attributes:
69+
label: Additional Context
70+
description: Add any other context about the problem here.
71+
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/config.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
blank_issues_enabled: false
3+
contact_links:
4+
- name: 💬 Talk to the NGINX community!
5+
url: https://community.nginx.org
6+
about: A community forum for NGINX users, developers, and contributors
7+
- name: 📝 Code of Conduct
8+
url: https://www.contributor-covenant.org/version/2/1/code_of_conduct
9+
about: NGINX follows the Contributor Covenant Code of Conduct to ensure a safe and inclusive community
10+
- name: 💼 For commercial & enterprise users
11+
url: https://www.f5.com/products/nginx
12+
about: F5 offers a wide range of NGINX products for commercial & enterprise users

.github/ISSUE_TEMPLATE/feature_request.md

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

.github/workflows/f5-cla.yml

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
name: F5 CLA
33
on:
44
issue_comment:
5-
types: [created]
5+
types: [ created ]
66
pull_request_target:
7-
types: [opened, closed, synchronize]
7+
types: [ opened, closed, synchronize ]
88
permissions: read-all
99
jobs:
1010
f5-cla:
@@ -19,19 +19,20 @@ jobs:
1919
if: (github.event.comment.body == 'recheck' || github.event.comment.body == 'I have hereby read the F5 CLA and agree to its terms') || github.event_name == 'pull_request_target'
2020
uses: contributor-assistant/github-action@ca4a40a7d1004f18d9960b404b97e5f30a505a08 # v2.6.1
2121
with:
22-
# Any pull request targeting the following branch will trigger a CLA check.
23-
branch: main
2422
# Path to the CLA document.
25-
path-to-document: https://github.com/f5/.github/blob/main/CLA/cla-markdown.md
23+
path-to-document: https://github.com/f5/f5-cla/blob/main/docs/f5_cla.md
2624
# Custom CLA messages.
27-
custom-notsigned-prcomment: '🎉 Thank you for your contribution! It appears you have not yet signed the F5 Contributor License Agreement (CLA), which is required for your changes to be incorporated into an F5 Open Source Software (OSS) project. Please kindly read the [F5 CLA](https://github.com/f5/.github/blob/main/CLA/cla-markdown.md) and reply on a new comment with the following text to agree:'
25+
custom-notsigned-prcomment: '🎉 Thank you for your contribution! It appears you have not yet signed the [F5 Contributor License Agreement (CLA)](https://github.com/f5/f5-cla/blob/main/docs/f5_cla.md), which is required for your changes to be incorporated into an F5 Open Source Software (OSS) project. Please kindly read the [F5 CLA](https://github.com/f5/f5-cla/blob/main/docs/f5_cla.md) and reply on a new comment with the following text to agree:'
2826
custom-pr-sign-comment: 'I have hereby read the F5 CLA and agree to its terms'
2927
custom-allsigned-prcomment: '✅ All required contributors have signed the F5 CLA for this PR. Thank you!'
3028
# Remote repository storing CLA signatures.
3129
remote-organization-name: f5
3230
remote-repository-name: f5-cla-data
31+
# Branch where CLA signatures are stored.
32+
branch: main
3333
path-to-signatures: signatures/signatures.json
3434
# Comma separated list of usernames for maintainers or any other individuals who should not be prompted for a CLA.
35+
# NOTE: You will want to edit the usernames to suit your project needs.
3536
allowlist: 4141done, alessfg, dekobon, bot*
3637
# Do not lock PRs after a merge.
3738
lock-pullrequest-aftermerge: false

.github/workflows/ossf-scorecard.yml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,26 @@ name: OSSF Scorecard
44
on:
55
# For Branch-Protection check. Only the default branch is supported. See https://github.com/ossf/scorecard/blob/main/docs/checks.md#branch-protection.
66
branch_protection_rule:
7-
push:
8-
branches: [main]
97
# To guarantee Maintained check is occasionally updated. See https://github.com/ossf/scorecard/blob/main/docs/checks.md#maintained.
108
schedule:
119
- cron: "0 0 * * 1"
10+
push:
11+
branches: [main, master]
1212
workflow_dispatch:
1313
# Declare default permissions as read only.
1414
permissions: read-all
1515
jobs:
1616
analysis:
1717
name: Scorecard analysis
1818
runs-on: ubuntu-24.04
19+
# Delete the conditional below if you are using the OSSF Scorecard on a private repository.
20+
if: ${{ github.event.repository.private == false }}
1921
permissions:
20-
# Needed if using Code Scanning alerts
22+
# Needed if using Code Scanning alerts.
2123
security-events: write
22-
# Needed for GitHub OIDC token if publish_results is true
24+
# Needed for GitHub OIDC token if publish_results is true.
2325
id-token: write
24-
# Uncomment the permissions below if installing on a private repository.
26+
# Uncomment the permissions below if you are using the OSSF Scorecard on a private repository.
2527
# contents: read
2628
# actions: read
2729
# issues: read # To allow GraphQL ListCommits to work
@@ -38,9 +40,7 @@ jobs:
3840
with:
3941
results_file: results.sarif
4042
results_format: sarif
41-
# (Optional) fine-grained personal access token. Uncomment the `repo_token` line below if:
42-
# - You want to enable the Branch-Protection check on a *public* repository.
43-
# - You are installing the OSSF Scorecard on a *private* repository.
43+
# (Optional) fine-grained personal access token. Uncomment the `repo_token` line below if you want to enable the Branch-Protection or Webhooks check on a *private* repository.
4444
# To create the PAT, follow the steps in https://github.com/ossf/scorecard-action#authentication-with-fine-grained-pat-optional.
4545
# repo_token: ${{ secrets.SCORECARD_TOKEN }}
4646

CONTRIBUTING.md

Lines changed: 32 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Contributing Guidelines
22

3-
The following is a set of guidelines for contributing to this project. We really appreciate that you are considering contributing!
3+
The following is a set of guidelines for contributing to this project. We really appreciate that you are considering
4+
contributing!
45

56
#### Table Of Contents
67

@@ -14,44 +15,57 @@ The following is a set of guidelines for contributing to this project. We really
1415

1516
## Getting Started
1617

17-
Follow the instructions on the README's [Getting Started Guide](/README.md#Getting-Started) section to get this project up and running.
18-
19-
<!-- ### Project Structure (OPTIONAL) -->
18+
Refer to the [Getting Started Guide](docs/getting_started.md) for how to build
19+
and run the gateway.
2020

2121
## Contributing
2222

2323
### Report a Bug
2424

25-
To report a bug, open an issue on GitHub with the label `bug` using the available bug report issue template. 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).**
25+
To report a bug, open an issue on GitHub with the label `bug` using the available bug report issue template. Please
26+
ensure the bug has not already been reported. **If the bug is a potential security vulnerability, please report it using
27+
our [security policy](/SECURITY.md).**
2628

2729
### Suggest a Feature or Enhancement
2830

29-
To suggest a feature or enhancement, please create an issue on GitHub with the label `enhancement` using the available [feature request template](/.github/feature_request_template.md). Please ensure the feature or enhancement has not already been suggested.
31+
To suggest a feature or enhancement, please create an issue on GitHub with the label `enhancement` using the
32+
available [feature request template](/.github/feature_request_template.md). Please ensure the feature or enhancement has
33+
not already been suggested.
3034

3135
### Open a Pull Request (PR)
3236

33-
- Fork the repo, create a branch, implement your changes, add any relevant tests, and submit a PR when your changes are **tested** and ready for review.
37+
- Fork the repo, create a branch, implement your changes, add any relevant tests, and submit a PR when your changes are
38+
**tested** and ready for review.
3439
- Fill in the [PR template](/.github/pull_request_template.md).
3540

36-
**Note:** If you'd like to implement a new feature, please consider creating a [feature request issue](/.github/feature_request_template.md) first to start a discussion about the feature.
41+
**Note:** If you'd like to implement a new feature, please consider creating
42+
a [feature request issue](/.github/feature_request_template.md) first to start a discussion about the feature.
3743

3844
#### F5 Contributor License Agreement (CLA)
3945

40-
F5 requires all external contributors to agree to the terms of the F5 CLA (available [here](https://github.com/f5/.github/blob/main/CLA/cla-markdown.md)) before any of their changes can be incorporated into an F5 Open Source repository.
46+
F5 requires all external contributors to agree to the terms of the F5 CLA (
47+
available [here](https://github.com/f5/.github/blob/main/CLA/cla-markdown.md)) before any of their changes can be
48+
incorporated into an F5 Open Source repository.
4149

42-
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.
50+
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
51+
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
52+
can be merged. Your agreement signature will be safely stored by F5 and no longer be required in future PRs.
4353

4454
## Code Guidelines
4555

4656
<!-- ### Go/Python/Bash/etc... Guidelines (OPTIONAL) -->
4757

4858
### Git Guidelines
4959

50-
- Keep a clean, concise and meaningful git commit history on your branch (within reason), rebasing locally and squashing before submitting a PR.
51-
- If possible and/or relevant, use the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) format when writing a commit message, so that changelogs can be automatically generated.
52-
- Follow the guidelines of writing a good commit message as described here <https://chris.beams.io/posts/git-commit/> and summarized in the next few points:
53-
- In the subject line, use the present tense ("Add feature" not "Added feature").
54-
- In the subject line, use the imperative mood ("Move cursor to..." not "Moves cursor to...").
55-
- Limit the subject line to 72 characters or less.
56-
- Reference issues and pull requests liberally after the subject line.
57-
- Add more detailed description in the body of the git message (`git commit -a` to give you more space and time in your text editor to write a good message instead of `git commit -am`).
60+
- Keep a clean, concise and meaningful git commit history on your branch (within reason), rebasing locally and squashing
61+
before submitting a PR.
62+
- If possible and/or relevant, use the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) format
63+
when writing a commit message, so that changelogs can be automatically generated.
64+
- Follow the guidelines of writing a good commit message as described here <https://chris.beams.io/posts/git-commit/>
65+
and summarized in the next few points:
66+
- In the subject line, use the present tense ("Add feature" not "Added feature").
67+
- In the subject line, use the imperative mood ("Move cursor to..." not "Moves cursor to...").
68+
- Limit the subject line to 72 characters or less.
69+
- Reference issues and pull requests liberally after the subject line.
70+
- Add more detailed description in the body of the git message (`git commit -a` to give you more space and time in
71+
your text editor to write a good message instead of `git commit -am`).

0 commit comments

Comments
 (0)