diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 69ecc82..8658daf 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,41 +1,23 @@ -# Pull Request Title: [Short Description of Changes] +# [Service Name]: [Summary of changes] + ## Description - -Provide a brief description of the changes made in this pull request. Include the following: - -- The purpose of the changes -- Any background context or additional details + ## Related Issues + +- None. -- Issue #[issue number] (e.g., Fixes #[issue number]) - -## Type of Change - -- [ ] Bug fix -- [ ] New feature -- [ ] Documentation update -- [ ] Refactoring - -## How Has This Been Tested? - -Describe the tests you ran to verify your changes. Provide instructions for reproducing the testing process: - -1. [Test case 1] -2. [Test case 2] +## Verification + ## Checklist -- [ ] I have performed a self-review of my code -- [ ] I have added tests that prove my fix or feature works -- [ ] I have updated necessary documentation (e.g. frontpage `README.md`) -- [ ] Any dependent changes have been merged and published in downstream modules - -## Screenshots (if applicable) - -If visual changes are made, include screenshots to demonstrate them. - -## Additional Notes +- [ ] I have performed a self-review of my code and followed the [templates](https://github.com/tailscale-dev/ScaleTail/tree/main/templates/service-template) structure. +- [ ] I have added verification that the stack works as expected. +- [ ] I have updated necessary documentation (e.g. frontpage [README.md](https://github.com/tailscale-dev/ScaleTail/blob/main/README.md) ). +- [ ] I have selected the correct label(s) for this PR. -Add any additional comments or information that may be relevant. +## Additional Context + +- None. diff --git a/README.md b/README.md index cdacc13..16087b8 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ [![Docker](https://img.shields.io/badge/Docker-2496ED?logo=docker&logoColor=fff)](https://www.docker.com/) [![Tailscale](https://img.shields.io/badge/Tailscale-cccccc?logo=tailscale&logoColor=fff)](https://tailscale.com/) -ScaleTail provides ready-to-run [Docker Compose](https://docs.docker.com/compose) stacks that instantly connect your self-hosted applications to your [Tailnet](https://tailscale.com/docs/concepts/tailnet). By using a sidecar configuration, your applications get an [URL](https://grokipedia.com/page/URL) with automatic [HTTPS](https://grokipedia.com/page/HTTPS), for example: `https://application.tail-net.ts.net`. +ScaleTail provides ready-to-run [Docker Compose](https://docs.docker.com/compose) stacks that instantly connect your self-hosted applications to your [Tailnet](https://tailscale.com/docs/concepts/tailnet). By using a Docker sidecar configuration, your applications get an [URL](https://grokipedia.com/page/URL) with automatic [HTTPS](https://grokipedia.com/page/HTTPS), for example: `https://application.tail-net.ts.net`. ## Featured by Tailscale @@ -229,7 +229,7 @@ Tailscale Funnel securely exposes services to the public internet. Tailscale Ser ### Tailscale Funnel -[Tailscale Funnel](https://tailscale.com/kb/1223/funnel) is a feature that lets you route traffic from the wider internet to a local service running on a machine in your Tailscale network (known as a Tailnet). You can think of this as publicly sharing a local service, like a web app, for anyone to access—even if they don’t have Tailscale themselves. +[Tailscale Funnel](https://tailscale.com/kb/1223/funnel) is a feature that lets you route traffic from the internet to a local service running on a machine in your Tailscale network (known as a Tailnet). You can think of this as publicly sharing a local service, like a web app, for anyone to access—even if they don’t have Tailscale themselves. ![Tailscale Funnel](images/tailscale-funnel.png)