-
Notifications
You must be signed in to change notification settings - Fork 21
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #136 from VaclavElias/update-16-correcting-references
fix: Correcting example references to Stride.CommunityToolkit.Windows
- Loading branch information
Showing
34 changed files
with
732 additions
and
113 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -348,3 +348,4 @@ MigrationBackup/ | |
|
||
# Ionide (cross platform F# VS Code tools) working folder | ||
.ionide/ | ||
/NDependOut |
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
# Contributing | ||
|
||
## Welcome Contributors | ||
|
||
We appreciate your interest in contributing to the Stride Community Toolkit. This section provides all the information you need to get started, including guidelines, best practices, and resources to help you make meaningful contributions to the project. Whether you're fixing bugs, adding new features, or improving documentation, your efforts are valuable and greatly appreciated. | ||
|
||
## Getting Started | ||
|
||
Since the toolkit is currently in preview, we don't have extensive instructions for contributors. However, you can follow these general guidelines to get started: | ||
|
||
- Feel free to make Pull Requests (PRs) directly to speed up your process. Optionally, create an issue on our [GitHub Issues](https://github.com/stride3d/stride-community-toolkit/issues) page, or work on an existing issue. Alternatively, you can start a discussion on our [GitHub Discussions](https://github.com/stride3d/stride-community-toolkit/discussions) page. | ||
- For quick communication with the community, join our Discord server and participate in the #toolkit channel [here](https://discord.com/channels/500285081265635328/1179562410655363132). | ||
|
||
## Documentation | ||
|
||
We use DocFX for our documentation. The easiest way to contribute to the documentation is by looking at existing docs, duplicating pages, and updating the content accordingly. You can find helpful information on using DocFX and writing Markdown [here](https://dotnet.github.io/docfx/docs/markdown.html). We will also assist you in getting started with the documentation. | ||
|
||
## Major Release Workflow | ||
|
||
When preparing for a major release, such as upgrading from **.NET 8** to **.NET 9**, there are several key steps and pages that need to be updated. This section will list the necessary instructions to ensure a smooth transition. | ||
|
||
### Steps for Major Release: | ||
|
||
1. Update .NET reference on the Home page's `index.md` | ||
1. Update .NET reference in `manual\gettings-started.md` | ||
1. Update .NET reference in `manual\code-only\create-project.md` | ||
1. Update `TargetFramework` in all `.csproj` files | ||
1. Test all examples and ensure they work as expected | ||
|
||
By following these steps, you can help ensure that each major release is well-documented and thoroughly tested, providing a smooth experience for all users of the toolkit. | ||
|
||
## Additional Resources | ||
|
||
- [Stride Community Toolkit GitHub Repository](https://github.com/stride3d/stride-community-toolkit) | ||
- [Stride Game Engine GitHub Repository](https://github.com/stride3d/stride) | ||
- [Stride Docs](https://doc.stride3d.net/) | ||
|
||
Thank you for contributing to the Stride Community Toolkit 🙂. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,2 @@ | ||
> [!NOTE] | ||
> The Stride Community Toolkit is currently in development. Documentation is incomplete and may contain errors. We published it early for your convenience, ahead of the toolkit's completion. | ||
> [!WARNING] | ||
> The toolkit is currently in development. Documentation is incomplete and may contain errors. We published it early for your convenience, ahead of the toolkit's completion. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,6 @@ | ||
This code example demonstrates how to initialize a game, set up a basic 3D scene, create a 3D capsule entity, set its position, and add it to the scene using the extensions provided by the toolkit. The `CreatePrimitive()` method, a part of the toolkit, automatically equips the capsule entity with a rigid body and a collider. This example serves as a simple starting point for building a game with Stride, leveraging the utilities provided by the toolkit to simplify common game development tasks. | ||
This code example demonstrates how to initialize a game, set up a basic 3D scene, add a skybox, create a 3D capsule entity, set its position, and add it to the scene using the extensions provided by the toolkit. The `Create3DPrimitive()` method, a part of the toolkit, automatically equips the capsule entity with a rigid body and a collider. This example serves as a simple starting point for building a game with Stride, leveraging the utilities provided by the toolkit to simplify common game development tasks. | ||
|
||
> [!NOTE] | ||
> This example requires the additional NuGet package `Stride.CommunityToolkit.Skyboxes`. Make sure to install it before running the code. | ||
![Stride UI Example](../../../manual/code-only/examples/media/stride-game-engine-example01-basic-3d-scene.webp) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.