|
1 | | -[](https://securityscorecards.dev/viewer/?uri=github.com/nginx/template-repository) |
2 | | -[](https://www.repostatus.org/#active) |
3 | | -[](/SUPPORT.md) |
4 | | -[](https://community.nginx.org) |
5 | | -[](https://opensource.org/license/apache-2-0) |
6 | | -[](/CODE_OF_CONDUCT.md) |
7 | | - |
8 | | -# NGINX Template Repository |
9 | | - |
10 | | -## What is included on this template? |
11 | | - |
12 | | -This template includes all the scaffolding you need to get started on an OSS repository that meets the required F5 & NGINX criteria: |
13 | | - |
14 | | -- [Apache License 2.0](/LICENSE) -> Required for all NGINX OSS projects unless otherwise determined by the project owner. |
15 | | -- [F5 CLA GitHub workflow](/.github/workflows/f5_cla.yml) -> For more details on the action please check the [F5 CLA documentation repository](https://github.com/f5/f5-cla). |
16 | | -- [`.gitignore`](/.gitignore) with some minimal sensible defaults. |
17 | | -- [Issue](/.github/ISSUE_TEMPLATE) and [PR](/.github/pull_request_template.md) templates. |
18 | | -- [Contributing](/CONTRIBUTING.md) guidelines. |
19 | | -- [Support](/SUPPORT.md) guidelines for either community and/or commercial support (uncomment the commercial block if necessary). |
20 | | -- [Security](/SECURITY.md) guidelines for reporting major vulnerabilities. |
21 | | -- [Code of Conduct](/CODE_OF_CONDUCT.md). |
22 | | -- Open Source Security Foundation (OSSF) Scorecard [(implemented via a GitHub Action)](/.github/workflows/ossf_scorecard.yml). This workflow only works on public repositories or private repositories using GitHub Advanced Security. |
23 | | -- [README](/README.md) placeholder. How you structure the README is up to you (although the template provides placeholder sections), but you will need to include: |
24 | | - - A [repostatus](https://www.repostatus.org/) badge. |
25 | | - - An OSSF Scorecard badge. (Optional -- Some projects will by their nature have low scores. In such a case you might want to remove this badge!). |
26 | | - - A community and/or commercial support badge. Include the latter -- and replace the commented out badge/URL placeholder with the relevant support URL -- if this repository contains a commercially supported project. You can find a commented out example below the community badge in this README. |
27 | | - - A contributor covenant/code of conduct badge. (Optional -- If you already have multiple badges and want to reduce clutter, simply including the actual code of conduct is enough!) |
28 | | - - An explicit link back to the [Apache License 2.0](/LICENSE). |
29 | | - - An up to date copyright notice. |
30 | | -- [Codeowners](/.github/CODEOWNERS) placeholder. (Optional -- Codeowners is a useful feature, but not all repositories require them.) |
31 | | -- [Changelog](/CHANGELOG.md) placeholder. (Optional -- A changelog is recommended, but it is not required and can diverge in format from the placeholder here included.) |
32 | | - |
33 | | -**Note:** If you created a public repository before this template became available (or you didn't know about it's existence), please include any missing files found here in your repository. There is no need if you have a private repository, but we still recommend you include all of the above scaffolding should the repository ever become public. |
34 | | - |
35 | | -## How do I use this template? |
36 | | - |
37 | | -**DO NOT FORK** -- this template is meant to be used from the **[`Use this template`](https://github.com/nginx/template-repository/generate)** feature. |
38 | | - |
39 | | -1. Click on **[`Use this template`](https://github.com/nginx/template-repository/generate)**. |
40 | | -2. Give a name to your project. |
41 | | -3. Wait until the first run of CI finishes (GitHub Actions will process the template and commit to your new repo). |
42 | | -4. Clone your new project and tweak any of the placeholders if necessary. Pay special attention to the README! This README section will self-destruct. |
43 | | -5. Happy coding! |
44 | | - |
45 | | -**NOTE**: **WAIT** until the first CI run on GitHub Actions finishes before cloning your new project. |
46 | | - |
47 | | ---- |
48 | 1 |
|
49 | 2 | [](https://www.repostatus.org/#concept) |
50 | | -[](https://securityscorecards.dev/viewer/?uri=github.com/{{REPOSITORY_OWNER}}/{{REPOSITORY_URL}}) |
| 3 | +[](https://securityscorecards.dev/viewer/?uri=github.com/nginx/waf-policy-controller) |
51 | 4 | [](/SUPPORT.md) <!-- [](<Insert URL>) --> |
52 | 5 | [](https://community.nginx.org) |
53 | 6 | [](https://opensource.org/license/apache-2-0) |
54 | 7 | [](/CODE_OF_CONDUCT.md) |
55 | 8 |
|
56 | | -# {{REPOSITORY_NAME}} |
| 9 | +# waf_policy_controller |
57 | 10 |
|
58 | 11 | ## Requirements |
59 | 12 |
|
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4&size=40){kind=avatar}
0 commit comments