Skip to content

Commit eec4fe8

Browse files
DylenTurnbullalessfg
DylenTurnbull
and
alessfg
authored
chore: Configure NGINX best practices per template repo (#7)
Co-authored-by: Alessandro Fael Garcia <[email protected]>
1 parent 418d9c8 commit eec4fe8

13 files changed

+381
-95
lines changed

‎.github/CODEOWNERS

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
#####################
2+
# Main global owner #
3+
#####################
4+
5+
* @nginx/docker-extension

‎.github/ISSUE_TEMPLATE/bug_report.yml

+66
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 or have a question, please consider starting a new thread via [GitHub discussions][discussions] or the [NGINX Community forum][forum].
16+
17+
[issue search]: https://github.com/nginx/docker-extension/issues
18+
[discussions]: https://github.com/nginx/docker-extension/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 use the NGINX Docker extension to 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 use the NGINX Docker extension to 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 use the NGINX Docker extension to 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/config.yml

+12
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.yml

+40
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 or have a question, please consider starting a new thread via [GitHub discussions][discussions] or the [NGINX Community forum][forum].
14+
15+
[issue search]: https://github.com/nginx/docker-extension/issues
16+
[discussions]: https://github.com/nginx/docker-extension/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/pull_request_template.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
### Proposed changes
2+
3+
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) in this PR's description or commit message.
4+
5+
### Checklist
6+
7+
Before creating a PR, run through this checklist and mark each as complete:
8+
9+
- [ ] I have read the [contributing guidelines](/CONTRIBUTING.md).
10+
- [ ] I have signed the [F5 Contributor License Agreement (CLA)](https://github.com/f5/f5-cla/blob/main/docs/f5_cla.md).
11+
- [ ] If applicable, I have added tests that prove my fix is effective or that my feature works.
12+
- [ ] If applicable, I have checked that any relevant tests pass after adding my changes.
13+
- [ ] I have updated any relevant documentation ([`README.md`](/README.md)).

‎.github/scorecard.yml

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
annotations:
3+
- checks:
4+
- fuzzing
5+
- packaging
6+
- sast
7+
- signed-releases
8+
reasons:
9+
- reason: not-applicable

‎.github/workflows/f5_cla.yml

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
name: F5 CLA
3+
on:
4+
issue_comment:
5+
types: [created]
6+
pull_request_target:
7+
types: [opened, closed, synchronize]
8+
permissions: read-all
9+
jobs:
10+
f5-cla:
11+
name: F5 CLA
12+
runs-on: ubuntu-24.04
13+
permissions:
14+
actions: write
15+
pull-requests: write
16+
statuses: write
17+
steps:
18+
- name: Run F5 Contributor License Agreement (CLA) assistant
19+
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'
20+
uses: contributor-assistant/github-action@ca4a40a7d1004f18d9960b404b97e5f30a505a08 # v2.6.1
21+
with:
22+
# Path to the CLA document.
23+
path-to-document: https://github.com/f5/f5-cla/blob/main/docs/f5_cla.md
24+
# Custom CLA messages.
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:'
26+
custom-pr-sign-comment: 'I have hereby read the F5 CLA and agree to its terms'
27+
custom-allsigned-prcomment: '✅ All required contributors have signed the F5 CLA for this PR. Thank you!'
28+
# Remote repository storing CLA signatures.
29+
remote-organization-name: f5
30+
remote-repository-name: f5-cla-data
31+
# Branch where CLA signatures are stored.
32+
branch: main
33+
path-to-signatures: signatures/signatures.json
34+
# 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.
36+
allowlist: bot*
37+
# Do not lock PRs after a merge.
38+
lock-pullrequest-aftermerge: false
39+
env:
40+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
41+
PERSONAL_ACCESS_TOKEN: ${{ secrets.F5_CLA_TOKEN }}

‎.github/workflows/ossf_scorecard.yml

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
# This workflow uses actions that are not certified by GitHub. They are provided by a third-party and are governed by separate terms of service, privacy policy, and support documentation.
3+
name: OSSF Scorecard
4+
on:
5+
# For Branch-Protection check. Only the default branch is supported. See https://github.com/ossf/scorecard/blob/main/docs/checks.md#branch-protection.
6+
branch_protection_rule:
7+
# To guarantee Maintained check is occasionally updated. See https://github.com/ossf/scorecard/blob/main/docs/checks.md#maintained.
8+
schedule:
9+
- cron: "0 0 * * 1"
10+
push:
11+
branches: [main]
12+
workflow_dispatch:
13+
# Declare default permissions as read only.
14+
permissions: read-all
15+
jobs:
16+
analysis:
17+
name: Scorecard analysis
18+
runs-on: ubuntu-24.04
19+
permissions:
20+
# Needed if using Code Scanning alerts.
21+
security-events: write
22+
# Needed for GitHub OIDC token if publish_results is true.
23+
id-token: write
24+
steps:
25+
- name: Check out the codebase
26+
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
27+
with:
28+
persist-credentials: false
29+
30+
- name: Run analysis
31+
uses: ossf/scorecard-action@f49aabe0b5af0936a0987cfb85d86b75731b0186 # v2.4.1
32+
with:
33+
results_file: results.sarif
34+
results_format: sarif
35+
publish_results: true
36+
37+
# Upload the results as artifacts (optional). Commenting out will disable uploads of run results in SARIF format to the repository Actions tab.
38+
- name: Upload artifact
39+
uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
40+
with:
41+
name: SARIF file
42+
path: results.sarif
43+
retention-days: 5
44+
45+
# Upload the results to GitHub's code scanning dashboard.
46+
- name: Upload SARIF results to code scanning
47+
uses: github/codeql-action/upload-sarif@5f8171a638ada777af81d42b55959a643bb29017 # v3.28.12
48+
with:
49+
sarif_file: results.sarif

‎CODE_OF_CONDUCT.md

+54-50
Original file line numberDiff line numberDiff line change
@@ -2,73 +2,77 @@
22

33
## Our Pledge
44

5-
In the interest of fostering an open and welcoming environment, we as
6-
contributors and maintainers pledge to making participation in our project and
7-
our community a harassment-free experience for everyone, regardless of age, body
8-
size, disability, ethnicity, sex characteristics, gender identity and expression,
9-
level of experience, education, socio-economic status, nationality, personal
10-
appearance, race, religion, or sexual identity and orientation.
5+
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
6+
7+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
118

129
## Our Standards
1310

14-
Examples of behavior that contributes to creating a positive environment
15-
include:
11+
Examples of behavior that contributes to a positive environment for our community include:
1612

17-
- Using welcoming and inclusive language
18-
- Being respectful of differing viewpoints and experiences
19-
- Gracefully accepting constructive criticism
20-
- Focusing on what is best for the community
21-
- Showing empathy towards other community members
13+
- Demonstrating empathy and kindness toward other people.
14+
- Being respectful of differing opinions, viewpoints, and experiences.
15+
- Giving and gracefully accepting constructive feedback.
16+
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience.
17+
- Focusing on what is best not just for us as individuals, but for the overall community.
2218

23-
Examples of unacceptable behavior by participants include:
19+
Examples of unacceptable behavior include:
2420

25-
- The use of sexualized language or imagery and unwelcome sexual attention or
26-
advances
27-
- Trolling, insulting/derogatory comments, and personal or political attacks
28-
- Public or private harassment
29-
- Publishing others' private information, such as a physical or electronic
30-
address, without explicit permission
31-
- Other conduct which could reasonably be considered inappropriate in a
32-
professional setting
21+
- The use of sexualized language or imagery, and sexual attention or advances of any kind.
22+
- Trolling, insulting or derogatory comments, and personal or political attacks.
23+
- Public or private harassment.
24+
- Publishing others' private information, such as a physical or email address, without their explicit permission.
25+
- Other conduct which could reasonably be considered inappropriate in a professional setting.
3326

34-
## Our Responsibilities
27+
## Enforcement Responsibilities
3528

36-
Project maintainers are responsible for clarifying the standards of acceptable
37-
behavior and are expected to take appropriate and fair corrective action in
38-
response to any instances of unacceptable behavior.
29+
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
3930

40-
Project maintainers have the right and responsibility to remove, edit, or
41-
reject comments, commits, code, wiki edits, issues, and other contributions
42-
that are not aligned to this Code of Conduct, or to ban temporarily or
43-
permanently any contributor for other behaviors that they deem inappropriate,
44-
threatening, offensive, or harmful.
31+
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
4532

4633
## Scope
4734

48-
This Code of Conduct applies both within project spaces and in public spaces
49-
when an individual is representing the project or its community. Examples of
50-
representing a project or community include using an official project e-mail
51-
address, posting via an official social media account, or acting as an appointed
52-
representative at an online or offline event. Representation of a project may be
53-
further defined and clarified by project maintainers.
35+
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official email address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
5436

5537
## Enforcement
5638

57-
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58-
reported by contacting the moderation team at [email protected]. All
59-
complaints will be reviewed and investigated and will result in a response that
60-
is deemed necessary and appropriate to the circumstances. The project team is
61-
obligated to maintain confidentiality with regard to the reporter of an incident.
62-
Further details of specific enforcement policies may be posted separately.
39+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at <[email protected]>. All complaints will be reviewed and investigated promptly and fairly.
40+
41+
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
42+
43+
## Enforcement Guidelines
44+
45+
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
46+
47+
### 1. Correction
48+
49+
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
50+
51+
**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
52+
53+
### 2. Warning
6354

64-
Project maintainers who do not follow or enforce the Code of Conduct in good
65-
faith may face temporary or permanent repercussions as determined by other
66-
members of the project's leadership.
55+
**Community Impact**: A violation through a single incident or series of actions.
56+
57+
**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
58+
59+
### 3. Temporary Ban
60+
61+
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
62+
63+
**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
64+
65+
### 4. Permanent Ban
66+
67+
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
68+
69+
**Consequence**: A permanent ban from any sort of public interaction within the community.
6770

6871
## Attribution
6972

70-
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 1.4,
71-
available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>
73+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.1, available at <https://www.contributor-covenant.org/version/2/1/code_of_conduct.html>.
74+
75+
Community Impact Guidelines were inspired by
76+
[Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/inclusion).
7277

73-
For answers to common questions about this code of conduct, see
74-
<https://www.contributor-covenant.org/faq>
78+
For answers to common questions about this code of conduct, see the FAQ at <https://www.contributor-covenant.org/faq>. Translations are available at <https://www.contributor-covenant.org/translations>.

0 commit comments

Comments
 (0)