Skip to content

Commit

Permalink
Add support badge requirement to the README
Browse files Browse the repository at this point in the history
  • Loading branch information
alessfg committed Jul 18, 2023
1 parent 9277d2b commit 001e6f9
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 3 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
[![Community Support](https://badgen.net/badge/support/community/cyan?icon=awesome)](https://github.com/nginxinc/{{REPOSITORY_OWNER}}/{{REPOSITORY_URL}}/blob/main/SUPPORT.md)
<!-- [![Commercial Support](https://badgen.net/badge/support/commercial/cyan?icon=awesome)](<Insert URL>) -->

# NGINX Template Repository

Expand All @@ -15,7 +17,8 @@ This template includes all the scaffolding you need to get started on a standard
- NGINX Code of Conduct
- README placeholder. How you structure the README is up to you (although the template provides placeholder sections), but you will need to include:
- A [repostatus](https://www.repostatus.org/) badge
- An explicit link back to the LICENSE
- A community and commercial support badge. Include the latter -- and replace the 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.
- An explicit link back to the [Apache License 2.0](https://github.com/nginxinc/template-repository/blob/main/LICENSE)
- An up to date copyright notice
- Changelog placeholder. (Optional -- A changelog is recommended, but it is not required and can diverge in format from the placeholder here included.)
- Codeowners placeholder. (Optional -- Codeowners is a useful GitHub feature, but not all repositories require them.)
Expand All @@ -27,7 +30,7 @@ This template includes all the scaffolding you need to get started on a standard
1. Click on **[`Use this template`](https://github.com/nginxinc/template-repository/generate)**
2. Give a name to your project
3. Wait until the first run of CI finishes (GitHub Actions will process the template and commit to your new repo)
4. Clone your new project and tweak any of the placeholders if necessary
4. Clone your new project and tweak any of the placeholders if necessary. Pay special attention to the README!
5. Happy coding!

**NOTE**: **WAIT** until the first CI run on GitHub Actions finishes before cloning your new project.
Expand Down
6 changes: 5 additions & 1 deletion SUPPORT.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This isn't the right place to get support for NGINX specific questions, but the

We have a community [Slack](https://nginxcommunity.slack.com/)!

If you are not a member click [here](https://community.nginx.org/joinslack) to sign up (and let us know if the link does not seem to be working!)
If you are not a member, click [here](https://community.nginx.org/joinslack) to sign up (and let us know if the link does not seem to be working!)

Once you join, check out the `#beginner-questions` and `nginx-users` channels :)

Expand All @@ -31,3 +31,7 @@ Want to get in touch with the NGINX development team directly? Try using the rel
## Contributing

Please see the [contributing guide](https://github.com/{{REPOSITORY_OWNER}}/{{REPOSITORY_URL}}/blob/main/CONTRIBUTING.md) for guidelines on how to best contribute to this project.

## Commercial Support

Commercial support for this project may be available. Please get in touch with [NGINX sales](https://www.nginx.com/contact-sales/) or check your contract details for more info!

0 comments on commit 001e6f9

Please sign in to comment.