Skip to content

Commit d33ff6c

Browse files
bavshin-f5bavshin-f5
committed
Add missing documentation and template files.
1 parent e9d7233 commit d33ff6c

File tree

12 files changed

+408
-7
lines changed

12 files changed

+408
-7
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml

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+
type: 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/nginx/nginx-acme/search?q=is%3Aissue&type=issues
18+
[discussions]: https://github.com/nginx/nginx-acme/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/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: true
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

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+
type: 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/nginx/nginx-acme/search?q=is%3Aissue&type=issues
16+
[discussions]: https://github.com/nginx/nginx-acme/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

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
version: 2
3+
updates:
4+
- package-ecosystem: "github-actions"
5+
directory: "/"
6+
schedule:
7+
interval: "weekly"
8+
day: "monday"
9+
10+
- package-ecosystem: "cargo"
11+
directory: "/"
12+
groups:
13+
all-dependencies:
14+
patterns:
15+
- "*"
16+
schedule:
17+
interval: "cron"
18+
cronjob: "1 2 1,15 * *"
19+
versioning-strategy: "increase-if-necessary"

‎.github/pull_request_template.md

Lines changed: 13 additions & 0 deletions
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) and/or [`CHANGELOG.md`](/CHANGELOG.md)).

‎.github/workflows/f5_cla.yml

Lines changed: 41 additions & 0 deletions
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 }}

‎.gitignore

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,34 @@
1+
########################
2+
# Any crt/keys/license #
3+
########################
4+
*.crt
5+
*.key
6+
7+
##########################
8+
# Backup/temporary files #
9+
##########################
10+
*~
11+
\#*
12+
13+
##################
14+
# MacOS specific #
15+
##################
16+
Thumbs.db
17+
.DS_Store
18+
19+
########################
20+
# Code editor specific #
21+
########################
22+
.idea
23+
.vscode
24+
25+
########
26+
# Logs #
27+
########
28+
*.log
29+
30+
###########################
31+
# Project build artifacts #
32+
###########################
133
/target
234
/objs-*

‎CODE_OF_CONDUCT.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
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.
8+
9+
## Our Standards
10+
11+
Examples of behavior that contributes to a positive environment for our community include:
12+
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.
18+
19+
Examples of unacceptable behavior include:
20+
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.
26+
27+
## Enforcement Responsibilities
28+
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.
30+
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.
32+
33+
## Scope
34+
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.
36+
37+
## Enforcement
38+
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
54+
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.
70+
71+
## Attribution
72+
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).
77+
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>.

‎CONTRIBUTING.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Contributing Guidelines
2+
3+
The following is a set of guidelines for contributing to this project. We really appreciate that you are considering contributing!
4+
5+
#### Table of Contents
6+
7+
- [Getting Started](#getting-started)
8+
- [Contributing](#contributing)
9+
- [Code of Conduct](/CODE_OF_CONDUCT.md)
10+
11+
## Getting Started
12+
13+
Follow the instructions on the README's [Getting Started](/README.md#Getting-Started) section to get this project up and running.
14+
15+
## Contributing
16+
17+
### Report a Bug
18+
19+
To report a bug, open an issue on GitHub with the type `Bug` using the available [bug report issue form](/.github/ISSUE_TEMPLATE/bug_report.yml). 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).**
20+
21+
### Suggest a Feature or Enhancement
22+
23+
To suggest a feature or enhancement, please create an issue on GitHub with the type `Enhancement` using the available [feature request issue form](/.github/ISSUE_TEMPLATE/feature_request.yml). Please ensure the feature or enhancement has not already been suggested.
24+
25+
### Open a Pull Request (PR)
26+
27+
- 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.
28+
- Fill in the [PR template](/.github/pull_request_template.md).
29+
30+
> [!NOTE]
31+
> If you'd like to implement a new feature, please consider creating a [feature request issue](/.github/ISSUE_TEMPLATE/feature_request.yml) first to start a discussion about the feature.
32+
33+
#### F5 Contributor License Agreement (CLA)
34+
35+
F5 requires all contributors to agree to the terms of the F5 CLA (available [here](https://github.com/f5/f5-cla/blob/main/docs/f5_cla.md)) before any of their changes can be incorporated into an F5 Open Source repository (even contributions to the F5 CLA itself!).
36+
37+
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.
38+
39+
### Git Guidelines
40+
41+
- Keep a clean, concise and meaningful git commit history on your branch (within reason), rebasing locally and squashing before submitting a PR.
42+
- 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:
43+
- In the subject line, use the present tense ("Add feature" not "Added feature").
44+
- In the subject line, use the imperative mood ("Move cursor to..." not "Moves cursor to...").
45+
- Limit the subject line to 72 characters or less.
46+
- Reference issues and pull requests liberally after the subject line.
47+
- 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`).

0 commit comments

Comments
 (0)