You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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].
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].
Copy file name to clipboardExpand all lines: .github/workflows/f5-cla.yml
+7-6Lines changed: 7 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -2,9 +2,9 @@
2
2
name: F5 CLA
3
3
on:
4
4
issue_comment:
5
-
types: [created]
5
+
types: [created]
6
6
pull_request_target:
7
-
types: [opened, closed, synchronize]
7
+
types: [opened, closed, synchronize]
8
8
permissions: read-all
9
9
jobs:
10
10
f5-cla:
@@ -19,19 +19,20 @@ jobs:
19
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'
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:'
28
26
custom-pr-sign-comment: 'I have hereby read the F5 CLA and agree to its terms'
29
27
custom-allsigned-prcomment: '✅ All required contributors have signed the F5 CLA for this PR. Thank you!'
30
28
# Remote repository storing CLA signatures.
31
29
remote-organization-name: f5
32
30
remote-repository-name: f5-cla-data
31
+
# Branch where CLA signatures are stored.
32
+
branch: main
33
33
path-to-signatures: signatures/signatures.json
34
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.
# Needed for GitHub OIDC token if publish_results is true
24
+
# Needed for GitHub OIDC token if publish_results is true.
23
25
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.
25
27
# contents: read
26
28
# actions: read
27
29
# issues: read # To allow GraphQL ListCommits to work
@@ -38,9 +40,7 @@ jobs:
38
40
with:
39
41
results_file: results.sarif
40
42
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.
44
44
# To create the PAT, follow the steps in https://github.com/ossf/scorecard-action#authentication-with-fine-grained-pat-optional.
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!
4
5
5
6
#### Table Of Contents
6
7
@@ -14,44 +15,57 @@ The following is a set of guidelines for contributing to this project. We really
14
15
15
16
## Getting Started
16
17
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.
20
20
21
21
## Contributing
22
22
23
23
### Report a Bug
24
24
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).**
26
28
27
29
### Suggest a Feature or Enhancement
28
30
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.
30
34
31
35
### Open a Pull Request (PR)
32
36
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.
34
39
- Fill in the [PR template](/.github/pull_request_template.md).
35
40
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.
37
43
38
44
#### F5 Contributor License Agreement (CLA)
39
45
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.
41
49
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.
- 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