You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
-
# ✨ Contributing to the .NET Aspire Community Toolkit
1
+
# ✨ Contributing to the Aspire Community Toolkit
2
2
3
-
Thank you for exhibiting interest in contributing to the .NET Aspire Community Toolkit. The team is delighted to welcome you onboard to our exciting and growing project. Any contribution or value added go a long way to enhance the project!
3
+
Thank you for exhibiting interest in contributing to the Aspire Community Toolkit. The team is delighted to welcome you onboard to our exciting and growing project. Any contribution or value added go a long way to enhance the project!
4
4
5
-
In the next few steps, you will be able to see a glimpse of ways you can contribute to the .NET Aspire Community Toolkit.
5
+
In the next few steps, you will be able to see a glimpse of ways you can contribute to the Aspire Community Toolkit.
6
6
7
7
## ❔ Questions <aname="question"></a>
8
8
@@ -14,11 +14,11 @@ If you find any bug, you can help the community by [submitting an issue](https:/
14
14
15
15
## 👌 Good First Issue <aname="issue"></a>
16
16
17
-
If this is your first time contributing to the .NET Aspire Community Toolkit and do not have advanced level programming experience, we have got you covered 💥 we have a list of [good first issue](https://github.com/CommunityToolkit/Aspire/labels/good%20first%20issue) that can be a great entryway to find and fix any issues that best fit your expertise or technical background.
17
+
If this is your first time contributing to the Aspire Community Toolkit and do not have advanced level programming experience, we have got you covered 💥 we have a list of [good first issue](https://github.com/CommunityToolkit/Aspire/labels/good%20first%20issue) that can be a great entryway to find and fix any issues that best fit your expertise or technical background.
18
18
19
19
## 🙋 Help Wanted <aname="help"></a>
20
20
21
-
The .NET Aspire Community Toolkit also has a list of issues that are labeled as [help wanted](https://github.com/CommunityToolkit/Aspire/labels/help%20wanted). The level of complexity in the list can vary but if you have an advanced level of programming experience, feel free to jump in to solve these issues.
21
+
The Aspire Community Toolkit also has a list of issues that are labeled as [help wanted](https://github.com/CommunityToolkit/Aspire/labels/help%20wanted). The level of complexity in the list can vary but if you have an advanced level of programming experience, feel free to jump in to solve these issues.
22
22
23
23
## 📬 Add New Feature <aname="feature"></a>
24
24
@@ -29,11 +29,11 @@ The .NET Aspire Community Toolkit also has a list of issues that are labeled as
29
29
30
30
## 📝 Add or Improve Documentation <aname="docs"></a>
31
31
32
-
The documentation for the .NET Aspire Community Toolkit is available on the [Microsoft Docs](https://learn.microsoft.com/dotnet/aspire/community-toolkit/). If you find any issues with the documentation or want to add more information, you can contribute by submitting a PR to [the documentation repository](https://github.com/dotnet/docs-aspire).
32
+
The documentation for the Aspire Community Toolkit is available on the [Microsoft Docs](https://learn.microsoft.com/dotnet/aspire/community-toolkit/). If you find any issues with the documentation or want to add more information, you can contribute by submitting a PR to [the documentation repository](https://github.com/dotnet/docs-aspire).
33
33
34
34
## 🚀 Create, Submit or Review Pull Request <aname="pr"></a>
35
35
36
-
Anyone can create a Pull Request by forking the .NET Aspire Community Toolkit Repository. Here is how you can [Create a Pull Request from fork](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork). Once you fork the .NET Aspire Community Toolkit repo, it is essential to create all changes in the feature branch of your forked repository. If you have the changes in the forked feature branch, you can then create a Pull Request in the main .NET Aspire Community Toolkit.
36
+
Anyone can create a Pull Request by forking the Aspire Community Toolkit Repository. Here is how you can [Create a Pull Request from fork](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork). Once you fork the Aspire Community Toolkit repo, it is essential to create all changes in the feature branch of your forked repository. If you have the changes in the forked feature branch, you can then create a Pull Request in the main Aspire Community Toolkit.
37
37
38
38
If this is your first time running the solution, be sure to familiarise yourself with [how to setup the development environment](./docs/setup.md).
39
39
@@ -49,7 +49,7 @@ Each PR that builds successfully will have a preview package created. You can fi
49
49
50
50
## 💙 Thank You
51
51
52
-
**Thank you so much for contributing to this amazing project. We hope you will continue to add value and find yourself as a highly reliable source to the .NET Aspire Community Toolkit.**
52
+
**Thank you so much for contributing to this amazing project. We hope you will continue to add value and find yourself as a highly reliable source to the Aspire Community Toolkit.**
The .NET Aspire Community Toolkit is a collection of integrations and extensions for developing with .NET Aspire.
7
+
The Aspire Community Toolkit is a collection of integrations and extensions for developing with Aspire.
8
8
9
-
All features are contributed by you, our amazing .NET community, and maintained by a core set of maintainers. Check out our [FAQ](./docs/faq.md) for more information.
9
+
All features are contributed by you, our amazing Aspire community, and maintained by a core set of maintainers. Check out our [FAQ](./docs/faq.md) for more information.
10
10
11
11
## 👀 What does this repo contain?
12
12
13
-
This repository contains the source code for the .NET Aspire Community Toolkit, a collection of community created Integrations and extensions for [.NET Aspire](https://aka.ms/dotnet/aspire).
13
+
This repository contains the source code for the Aspire Community Toolkit, a collection of community created Integrations and extensions for [Aspire](https://aka.ms/dotnet/aspire).
| - **Learn More**: [`Hosting.Sqlite`][sqlite-integration-docs] <br /> - Stable 📦: [![CommunityToolkit.Aspire.Hosting.Sqlite][sqlite-shields]][sqlite-hosting-nuget] <br /> - Preview 📦: [![CommunityToolkit.Aspire.Hosting.Sqlite][sqlite-shields-preview]][sqlite-hosting-nuget-preview]| An Aspire hosting integration to setup a SQLite database with optional SQLite Web as a dev UI. |
35
35
| - **Learn More**: [`Microsoft.Data.Sqlite`][sqlite-integration-docs] <br /> - Stable 📦: [![CommunityToolkit.Aspire.Microsoft.Data.Sqlite][sqlite-shields]][sqlite-nuget] <br /> - Preview 📦: [![CommunityToolkit.Aspire.Microsoft.Data.Sqlite][sqlite-shields-preview]][sqlite-nuget-preview]| An Aspire client integration for the Microsoft.Data.Sqlite NuGet package. |
@@ -70,7 +70,7 @@ _Stable releases are not published to the Azure Artifacts feeds, they can only b
70
70
71
71
## 📃 Documentation
72
72
73
-
Documentation for the .NET Aspire Community Toolkit is available on the [Microsoft Docs](https://learn.microsoft.com/dotnet/aspire/community-toolkit/overview).
73
+
Documentation for the Aspire Community Toolkit is available on the [Microsoft Docs](https://learn.microsoft.com/dotnet/aspire/community-toolkit/overview).
Copy file name to clipboardExpand all lines: docs/create-integration.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,12 @@
1
1
## 💡 Creating an Integration
2
2
3
-
So, you want to create a new integration for the .NET Aspire Community Toolkit? That's awesome! This guide will walk you through the process of creating a new integration.
3
+
So, you want to create a new integration for the Aspire Community Toolkit? That's awesome! This guide will walk you through the process of creating a new integration.
4
4
5
5
First up, make sure you've had a read of the [Contributing guide](../CONTRIBUTING.md) to understand the contribution guidelines, and then familiarise yourself with creating a custom .NET Aspire integration for [hosting](https://learn.microsoft.com/dotnet/aspire/extensibility/custom-hosting-integration?tabs=windows) or for [clients](https://learn.microsoft.com/dotnet/aspire/extensibility/custom-client-integration).
6
6
7
7
## 📂 Repository Structure
8
8
9
-
The repository structure for the .NET Aspire Community Toolkit is as follows:
9
+
The repository structure for the Aspire Community Toolkit is as follows:
10
10
11
11
-`src/` - Contains the source code for the toolkit and where you'll create your integration.
12
12
-`tests/` - Contains the test projects for the toolkit and where you'll create unit and integration tests (where applicable).
@@ -133,4 +133,4 @@ Here's an example from the OllamaSharp integration:
133
133
134
134
## 🎉 You're done
135
135
136
-
That's it! You've created a new integration for the .NET Aspire Community Toolkit. If you have any questions or need help, feel free to reach out to the maintainers or the community on GitHub Discussions.
136
+
That's it! You've created a new integration for the Aspire Community Toolkit. If you have any questions or need help, feel free to reach out to the maintainers or the community on GitHub Discussions.
Copy file name to clipboardExpand all lines: docs/diagnostics.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,14 @@
1
-
# .NET Aspire Community Toolkit Diagnostics
1
+
# Aspire Community Toolkit Diagnostics
2
2
3
-
Some of the API's in the .NET Aspire Community Toolkit are decorated with the [`ExperimentalAttrible`](https://learn.microsoft.com/dotnet/api/system.diagnostics.codeanalysis.experimentalattribute). This attribute is used to indicate that an API is not ready for production use and is subject to change in the future.
3
+
Some of the API's in the Aspire Community Toolkit are decorated with the [`ExperimentalAttrible`](https://learn.microsoft.com/dotnet/api/system.diagnostics.codeanalysis.experimentalattribute). This attribute is used to indicate that an API is not ready for production use and is subject to change in the future.
4
4
5
5
## CTASPIRE001
6
6
7
-
There are cases where there is an API provided by the .NET Aspire Community Toolkit that is an intermidiary solution until a feature is added to .NET Aspire itself. This could be a private API that is not yet ready for public consumption, or a workaround waiting for the completion of a feature in .NET Aspire.
7
+
There are cases where there is an API provided by the Aspire Community Toolkit that is an intermidiary solution until a feature is added to .NET Aspire itself. This could be a private API that is not yet ready for public consumption, or a workaround waiting for the completion of a feature in .NET Aspire.
8
8
9
9
In these cases, refer to the `<remarks>` docs section of the API for more information on the feature in .NET Aspire and the issue(s) to track.
10
10
11
-
Once a release of .NET Aspire with that API is available, the API in the .NET Aspire Community Toolkit will be marked as obsolete and will be removed in a future release.
11
+
Once a release of .NET Aspire with that API is available, the API in the Aspire Community Toolkit will be marked as obsolete and will be removed in a future release.
Copy file name to clipboardExpand all lines: docs/faq.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,19 +6,19 @@ The goal of the project is to be a centralised home for extensions and integrati
6
6
7
7
## How is this project different from the official .NET Aspire project?
8
8
9
-
The .NET Aspire Community Toolkit is a community-driven project that is maintained by the community and is not officially supported by the .NET Aspire team. The toolkit is a collection of integrations and extensions that are built on top of the .NET Aspire project.
9
+
The Aspire Community Toolkit is a community-driven project that is maintained by the community and is not officially supported by the .NET Aspire team. The toolkit is a collection of integrations and extensions that are built on top of the .NET Aspire project.
10
10
11
11
## How can I contribute to the project?
12
12
13
-
Anyone can contribute to the .NET Aspire Community Toolkit and before you get started, be sure to read the [Contributing Guide](../CONTRIBUTING.md) to learn how to contribute to the project.
13
+
Anyone can contribute to the Aspire Community Toolkit and before you get started, be sure to read the [Contributing Guide](../CONTRIBUTING.md) to learn how to contribute to the project.
14
14
15
15
## Should I propose a new integration here on or the `dotnet/aspire` repo?
16
16
17
-
If you have an idea for a new integration, you should propose it here on the .NET Aspire Community Toolkit repository, rather than [`dotnet/aspire`](https://github.com/dotnet/aspire), as the official .NET Aspire project is focused on the core functionality of the .NET Aspire project.
17
+
If you have an idea for a new integration, you should propose it here on the Aspire Community Toolkit repository, rather than [`dotnet/aspire`](https://github.com/dotnet/aspire), as the official .NET Aspire project is focused on the core functionality of the .NET Aspire project.
18
18
19
19
If you have previously proposed an integration on the `dotnet/aspire` repository, you can still propose it here, but link to the existing issue on the `dotnet/aspire` repository to provide context.
20
20
21
21
## Finding Community Toolkit Integrations
22
22
23
-
Integrations from the .NET Aspire Community Toolkit will appear in the "Add Aspire Integration" dialog in Visual Studio under the namespace `CommunityToolkit.Aspire.*`.
23
+
Integrations from the Aspire Community Toolkit will appear in the "Add Aspire Integration" dialog in Visual Studio under the namespace `CommunityToolkit.Aspire.*`.
0 commit comments