From 001e6f9fec1da1c6b02786215788603d0116fad4 Mon Sep 17 00:00:00 2001 From: Alessandro Fael Garcia Date: Mon, 10 Jul 2023 23:27:58 +0200 Subject: [PATCH] Add support badge requirement to the README --- README.md | 7 +++++-- SUPPORT.md | 6 +++++- 2 files changed, 10 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f40439b..6622357 100644 --- a/README.md +++ b/README.md @@ -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) + # NGINX Template Repository @@ -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.) @@ -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. diff --git a/SUPPORT.md b/SUPPORT.md index 9a23b57..4640884 100644 --- a/SUPPORT.md +++ b/SUPPORT.md @@ -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 :) @@ -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!