docs: add issue templates for both packages, update README (#206)

launchdarkly · Apr 23, 2024 · f5ba86d · f5ba86d
1 parent c641644
commit f5ba86d
Show file tree

Hide file tree

Showing 5 changed files with 98 additions and 10 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md → ...UE_TEMPLATE/package-server--bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md → ...UE_TEMPLATE/package-server--bug_report.md
@@ -1,8 +1,8 @@
 ---
-name: Bug report
+name: LaunchDarkly.ServerSdk Bug report
 about: Create a report to help us improve
 title: ''
-labels: ''
+labels: 'package: sdk/server, bug'
 assignees: ''
 
 ---
@@ -28,10 +28,10 @@ If applicable, add any log output related to your problem.
 The version of this SDK that you are using.
 
 **Language version, developer tools**
-For instance, Go 1.11 or Ruby 2.5.3. If you are using a language that requires a separate compiler, such as C, please include the name and version of the compiler too.
+For instance, .NET 6.0. 
 
 **OS/platform**
-For instance, Ubuntu 16.04, Windows 10, or Android 4.0.3. If your code is running in a browser, please also include the browser type and version.
+For instance, Ubuntu 16.04, Windows 10, or Android 4.0.3. 
 
 **Additional context**
 Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md → ...MPLATE/package-server--feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md → ...MPLATE/package-server--feature_request.md
@@ -1,8 +1,8 @@
 ---
-name: Feature request
+name: LaunchDarkly.ServerSdk Feature request
 about: Suggest an idea for this project
 title: ''
-labels: ''
+labels: 'package: sdk/server, feature'
 assignees: ''
 
 ---

diff --git a/.github/ISSUE_TEMPLATE/package-telemetry--bug_report.md b/.github/ISSUE_TEMPLATE/package-telemetry--bug_report.md
@@ -0,0 +1,37 @@
+---
+name: LaunchDarkly.ServerSdk.Telemetry Bug report
+about: Create a report to help us improve
+title: ''
+labels: 'package: telemetry, bug'
+assignees: ''
+
+---
+
+**Is this a support request?**
+This issue tracker is maintained by LaunchDarkly SDK developers and is intended for feedback on the SDK code. If you're not sure whether the problem you are having is specifically related to the SDK, or to the LaunchDarkly service overall, it may be more appropriate to contact the LaunchDarkly support team; they can help to investigate the problem and will consult the SDK team if necessary. You can submit a support request by going [here](https://support.launchdarkly.com/hc/en-us/requests/new) or by emailing [email protected].
+
+Note that issues filed on this issue tracker are publicly accessible. Do not provide any private account information on your issues. If your problem is specific to your account, you should submit a support request as described above.
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To reproduce**
+Steps to reproduce the behavior.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Logs**
+If applicable, add any log output related to your problem.
+
+**SDK version**
+The version of this SDK that you are using.
+
+**Language version, developer tools**
+For instance, .NET 6.0. 
+
+**OS/platform**
+For instance, Ubuntu 16.04, Windows 10, or Android 4.0.3. 
+
+**Additional context**
+Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/package-telemetry--feature_request.md b/.github/ISSUE_TEMPLATE/package-telemetry--feature_request.md
@@ -0,0 +1,20 @@
+---
+name: LaunchDarkly.ServerSdk.Telemetry Feature request
+about: Suggest an idea for this project
+title: ''
+labels: 'package: telemetry, feature'
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I would love to see the SDK [...does something new...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context about the feature request here.
diff --git a/README.md b/README.md
@@ -1,13 +1,27 @@
 # LaunchDarkly Server-Side SDK for .NET
 
-[![NuGet](https://img.shields.io/nuget/v/LaunchDarkly.ServerSdk.svg?style=flat-square)](https://www.nuget.org/packages/LaunchDarkly.ServerSdk/)
-[![CI](https://github.com/launchdarkly/dotnet-server-sdk/actions/workflows/ci.yml/badge.svg)](https://github.com/launchdarkly/dotnet-server-sdk/actions/workflows/ci.yml)
-[![Documentation](https://img.shields.io/static/v1?label=GitHub+Pages&message=API+reference&color=00add8)](https://launchdarkly.github.io/dotnet-server-sdk)
-
 The LaunchDarkly Server-Side SDK for .NET is designed primarily for use in multi-user systems such as web servers and applications. It follows the server-side LaunchDarkly model for multi-user contexts. It is not intended for use in desktop and embedded systems applications.
 
 For using LaunchDarkly in *client-side* .NET applications, including mobile (Xamarin) applications and desktop applications, refer to our [Xamarin SDK](https://github.com/launchdarkly/xamarin-client-sdk).
 
+## Packages
+
+| SDK Packages                     | NuGet                                                   | API Docs                                                    | Issues                        | Tests                                                      |
+|----------------------------------|---------------------------------------------------------|-------------------------------------------------------------|-------------------------------|------------------------------------------------------------|
+| LaunchDarkly.ServerSdk           | [![NuGet][server-nuget-badge]][server-nuget-link]       | [![Documentation][api-docs-badge]][server-api-docs-link]    | [Server SDK][server-issues]   | [![Actions Status][server-ci-badge]][server-ci-link]       |
+
+| Telemetry Packages               | NuGet                                                   | API Docs                                                    | Issues                        | Tests                                                      |
+|----------------------------------|---------------------------------------------------------|-------------------------------------------------------------|-------------------------------|------------------------------------------------------------|
+| LaunchDarkly.ServerSdk.Telemetry | [![NuGet][telemetry-nuget-badge]][telemetry-nuget-link] | [![Documentation][api-docs-badge]][telemetry-api-docs-link] | [Telemetry][telemetry-issues] | [![Actions Status][telemetry-ci-badge]][telemetry-ci-link] |
+
+## Organization
+
+| Directory        | Purpose                                                                                                    |
+|------------------|------------------------------------------------------------------------------------------------------------|
+| `pkgs`           | Top level directory containing package implementations.                                                    |
+| `pkgs/sdk`       | SDK packages intended for use by application developers. Currently contains only the .NET Server-Side SDK. |
+| `pkgs/telemetry` | Packages for adding telemetry support to SDKs.                                                             |
+
 ## LaunchDarkly overview
 
 [LaunchDarkly](https://www.launchdarkly.com) is a feature management platform that serves trillions of feature flags daily to help teams build better software, faster. [Get started](https://docs.launchdarkly.com/home/getting-started) using LaunchDarkly today!
@@ -75,3 +89,20 @@ We encourage pull requests and other contributions from the community. Check out
     * [docs.launchdarkly.com](https://docs.launchdarkly.com/  "LaunchDarkly Documentation") for our documentation and SDK reference guides
     * [apidocs.launchdarkly.com](https://apidocs.launchdarkly.com/  "LaunchDarkly API Documentation") for our API documentation
     * [blog.launchdarkly.com](https://blog.launchdarkly.com/  "LaunchDarkly Blog Documentation") for the latest product updates
+
+
+[server-nuget-badge]: https://img.shields.io/nuget/v/LaunchDarkly.ServerSdk.svg?style=flat-square
+[server-nuget-link]: https://www.nuget.org/packages/LaunchDarkly.ServerSdk/
+[server-ci-badge]: https://github.com/launchdarkly/dotnet-server-sdk/actions/workflows/sdk-server-ci.yml/badge.svg
+[server-ci-link]: https://github.com/launchdarkly/dotnet-server-sdk/actions/workflows/sdk-server-ci.yml
+[server-issues]: https://github.com/launchdarkly/dotnet-server-sdk/issues?q=is%3Aissue+is%3Aopen+label%3A%22package%3A+sdk%2Fserver%22+
+[server-api-docs-link]: https://launchdarkly.github.io/dotnet-server-sdk/
+
+[telemetry-nuget-badge]: https://img.shields.io/nuget/v/LaunchDarkly.ServerSdk.Telemetry.svg?style=flat-square
+[telemetry-nuget-link]: https://www.nuget.org/packages/LaunchDarkly.ServerSdk.Telemetry/
+[telemetry-ci-badge]: https://github.com/launchdarkly/dotnet-server-sdk/actions/workflows/telemetry-ci.yml/badge.svg
+[telemetry-ci-link]: https://github.com/launchdarkly/dotnet-server-sdk/actions/workflows/telemetry-ci.yml
+[telemetry-issues]: https://github.com/launchdarkly/dotnet-server-sdk/issues?q=is%3Aissue+is%3Aopen+label%3A%22package%3A+telemetry%22+
+[telemetry-api-docs-link]: https://launchdarkly.github.io/dotnet-server-sdk/
+
+[api-docs-badge]: https://img.shields.io/static/v1?label=GitHub+Pages&message=API+reference&color=00add8