|
9 | 9 |
|
10 | 10 | This template includes all the scaffolding you need to get started on an OSS repository that meets the required NGINX criteria:
|
11 | 11 |
|
12 |
| -- [Apache License 2.0](/LICENSE) (required for all NGINX OSS projects) |
13 |
| -- [`.gitignore`](/.gitignore) with some minimal sensible defaults |
14 |
| -- [Issue](/.github/ISSUE_TEMPLATE) and [PR](/.github//pull_request_template.md) templates |
15 |
| -- [Contributing](/CONTRIBUTING.md) guidelines |
16 |
| -- [Support](/SUPPORT.md) guidelines for either community and/or commercial support (uncomment either ) |
17 |
| -- [Security](/SECURITY.md) guidelines for reporting major vulnerabilities |
18 |
| -- [Code of Conduct](/CODE_OF_CONDUCT.md) |
| 12 | +- [Apache License 2.0](/LICENSE) (required for all NGINX OSS projects). |
| 13 | +- [`.gitignore`](/.gitignore) with some minimal sensible defaults. |
| 14 | +- [Issue](/.github/ISSUE_TEMPLATE) and [PR](/.github//pull_request_template.md) templates. |
| 15 | +- [Contributing](/CONTRIBUTING.md) guidelines. |
| 16 | +- [Support](/SUPPORT.md) guidelines for either community and/or commercial support (uncomment the commercial block if necessary). |
| 17 | +- [Security](/SECURITY.md) guidelines for reporting major vulnerabilities. |
| 18 | +- [Code of Conduct](/CODE_OF_CONDUCT.md). |
| 19 | +- [F5 CLA workflow](/.github/workflows/f5-cla.yml). For more details on the action please check the [F5 CLA signature datastore repository](https://github.com/f5/f5-cla-data). |
19 | 20 | - Open Source Security Foundation (OSSF) Scorecard [(implemented via a GitHub Action)](/.github/workflows/ossf_scorecard.yml)
|
20 | 21 | - [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:
|
21 |
| - - A [repostatus](https://www.repostatus.org/) badge |
22 |
| - - 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!) |
| 22 | + - A [repostatus](https://www.repostatus.org/) badge. |
| 23 | + - 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!). |
23 | 24 | - 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.
|
24 | 25 | - 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!)
|
25 |
| - - An explicit link back to the [Apache License 2.0](/LICENSE) |
26 |
| - - An up to date copyright notice |
| 26 | + - An explicit link back to the [Apache License 2.0](/LICENSE). |
| 27 | + - An up to date copyright notice. |
27 | 28 | - [Changelog](/CHANGELOG.md) placeholder. (Optional -- A changelog is recommended, but it is not required and can diverge in format from the placeholder here included.)
|
28 | 29 | - [Codeowners](/.github/CODEOWNERS) placeholder. (Optional -- Codeowners is a useful feature, but not all repositories require them.)
|
29 | 30 |
|
|
0 commit comments