{"id":30616391,"url":"https://github.com/mikeschulze/gdunit4netexamples","last_synced_at":"2025-08-30T09:19:36.044Z","repository":{"id":311107731,"uuid":"972845224","full_name":"MikeSchulze/gdUnit4NetExamples","owner":"MikeSchulze","description":"Complete gdUnit4Net examples repository featuring basic tutorials, advanced testing patterns, real-world demos, and best practices for C# unit testing in Godot 4.","archived":false,"fork":false,"pushed_at":"2025-08-29T18:29:05.000Z","size":708,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-08-29T19:09:14.610Z","etag":null,"topics":["csharp","examples","gdunit4","gdunit4net","godot","godot4","tutorials","unit-testing","unit-testing-framework"],"latest_commit_sha":null,"homepage":"https://github.com/MikeSchulze/gdUnit4Net","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MikeSchulze.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-04-25T19:02:06.000Z","updated_at":"2025-08-29T18:29:07.000Z","dependencies_parsed_at":"2025-08-22T07:26:22.550Z","dependency_job_id":"8aee6fc4-838a-4285-bcff-57bb44b55ecd","html_url":"https://github.com/MikeSchulze/gdUnit4NetExamples","commit_stats":null,"previous_names":["mikeschulze/gdunit4netexamples"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/MikeSchulze/gdUnit4NetExamples","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MikeSchulze%2FgdUnit4NetExamples","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MikeSchulze%2FgdUnit4NetExamples/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MikeSchulze%2FgdUnit4NetExamples/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MikeSchulze%2FgdUnit4NetExamples/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MikeSchulze","download_url":"https://codeload.github.com/MikeSchulze/gdUnit4NetExamples/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MikeSchulze%2FgdUnit4NetExamples/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":272830537,"owners_count":25000471,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-30T02:00:09.474Z","response_time":77,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["csharp","examples","gdunit4","gdunit4net","godot","godot4","tutorials","unit-testing","unit-testing-framework"],"created_at":"2025-08-30T09:19:32.701Z","updated_at":"2025-08-30T09:19:36.035Z","avatar_url":"https://github.com/MikeSchulze.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003eGdUnit4Net Examples\u003c/h1\u003e\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"assets/wip.png\" alt=\"\" width=\"50%\"\u003e\u003c/br\u003e\n\u003c/p\u003e\n\nThis repository contains example projects and test cases demonstrating how to use [gdUnit4Net](https://github.com/MikeSchulze/gdUnit4Net), a C# unit testing framework for Godot 4.\n\n## Table of Contents\n\n- [Examples \u0026 Quick Start](/Examples/README.md)\n- [Requirements \u0026 Prerequisites](#requirements--prerequisites)\n- [Installation](#installation)\n- [Code Quality and Best Practices](#code-quality-and-best-practices)\n    - [Build Configuration](#build-configuration)\n    - [Code Style Enforcement](#code-style-enforcement)\n    - [Documentation Practices](#documentation-practices)\n    - [IDE Integration](#ide-integration)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Project Structure\n\n- **Examples/** - Complete examples and tutorials\n- **Demos/** - Full demo projects with comprehensive tests\n\n## Requirements \u0026 Prerequisites\n\nTo work with this project, you'll need:\n\n### Software Requirements\n\n- **Godot Engine**: Version 4.4.x with .NET/Mono support enabled\n- **.NET SDK**: Version 9.0.x\n- **IDE**: One of the following:\n    - Visual Studio 2022\n    - Visual Studio Code with C# extension\n    - JetBrains Rider (recommended for best testing experience)\n\n### Project Specifications\n\n- **Framework**: .NET 9.0\n- **Language Version**: C# 12.0\n- **Code Style**: Standard .NET naming conventions and formatting (enforced via .editorconfig)\n- **Documentation**: XML documentation required for all public members\n\n---\n\n## Installation\n\n### Setup Steps\n\n1. **Clone the repository**\n   ```bash\n   git clone https://github.com/MikeSchulze/gdUnit4NetExamples.git\n   cd gdUnit4NetExamples\n   ```\n\n2. **Verify your installed .NET SDKs**\n   ```bash\n   dotnet --list-sdks\n    7.0.404 [C:\\Program Files\\dotnet\\sdk]\n    8.0.411 [C:\\Program Files\\dotnet\\sdk]\n   ```\n   Ensure .NET 9.0.x is listed among the installed SDKs.\n\n   **If .NET 9.0 is not installed:**\n\n   a. Download the .NET 9.0 SDK from the [official .NET download page](https://dotnet.microsoft.com/download/dotnet)\n\n   b. Follow the installation instructions for your operating system\n\n   c. After installation, verify with:\n   ```bash\n   dotnet --list-sdks\n    7.0.404 [C:\\Program Files\\dotnet\\sdk]\n    8.0.411 [C:\\Program Files\\dotnet\\sdk]\n    9.0.304 [C:\\Program Files\\dotnet\\sdk]\n   ```\n\n3. **Build the project**\n   ```bash\n   dotnet build\n   ```\n   This will restore all required NuGet packages and build the project.\n\n---\n\n---\n\n## Code Quality and Best Practices\n\nThis example project demonstrates not only how to use GdUnit4Net for testing but also showcases best practices for maintaining high-quality C# code in Godot projects.\n\n### Build Configuration\n\n#### Directory.Build.props\n\nWe use a `Directory.Build.props` file to centralize common build settings across all projects. This ensures consistent code quality enforcement without having to duplicate settings\nin each project file.\n\nKey features:\n\n- Enables .NET code analyzers\n- Enforces code style rules during build\n- Treats warnings as errors to maintain strict quality standards\n- Generates XML documentation from code comments\n- Includes StyleCop and Microsoft analyzers for comprehensive rule checking\n\n```xml\n\u003cPropertyGroup\u003e\n  \u003cEnableNETAnalyzers\u003etrue\u003c/EnableNETAnalyzers\u003e\n  \u003cAnalysisLevel\u003elatest\u003c/AnalysisLevel\u003e\n  \u003cAnalysisMode\u003eAll\u003c/AnalysisMode\u003e\n  \u003cEnforceCodeStyleInBuild\u003etrue\u003c/EnforceCodeStyleInBuild\u003e\n  \u003cTreatWarningsAsErrors\u003etrue\u003c/TreatWarningsAsErrors\u003e\n  \u003cGenerateDocumentationFile\u003etrue\u003c/GenerateDocumentationFile\u003e\n\u003c/PropertyGroup\u003e\n```\n\n### Code Style Enforcement\n\n#### .editorconfig\n\nThe repository includes a comprehensive `.editorconfig` file that defines coding standards. This file is automatically recognized by Visual Studio, VS Code, Rider, and other\neditors that support the EditorConfig standard.\n\nBenefits:\n\n- Consistent code formatting across all team members\n- Automatic enforcement of naming conventions\n- Standardized indentation, spacing, and line breaks\n- Enforced documentation practices\n\n### Documentation Practices\n\nAll code in this example project includes proper XML documentation:\n\n- Classes are documented with `\u003csummary\u003e` tags explaining their purpose\n- Methods include parameter descriptions and return value documentation\n- Examples demonstrate good practices for documenting test intentions\n\nExample:\n\n```csharp\n/// \u003csummary\u003e\n/// Demonstrates comparing two Godot.Vector2 instances.\n///\n/// This test verifies that Godot's Vector2 equality comparison works correctly.\n/// Note that this is testing Godot's Vector2 type, not the System.Numerics.Vector2 type.\n/// \u003c/summary\u003e\n[TestCase]\npublic void CompareGodotVector2()\n    =\u003e AssertThat(new Vector2(1, 1)).IsEqual(new Vector2(1, 1));\n```\n\n### IDE Integration\n\nThis project is configured to work seamlessly with major IDEs:\n\n#### Visual Studio\n\n- Format on save is enabled through EditorConfig\n- Code analysis runs in real-time\n- XML documentation is validated during build\n\n#### Visual Studio Code\n\n- Settings in .vscode/settings.json configure the C# extension\n- OmniSharp is configured to respect EditorConfig rules\n- Format on save and analysis are enabled\n\n#### JetBrains Rider\n\n- EditorConfig support is enabled\n- Code inspection profiles match the project standards\n- Automatic formatting on save is configured\n\n### Benefits for Your Projects\n\nBy following these patterns, you can:\n\n1. Ensure consistent code quality across your team\n2. Catch issues early through static analysis\n3. Maintain readable and well-documented code\n4. Reduce the effort needed for code reviews\n5. Make your codebase more maintainable in the long term\n\n## Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\n## License\n\nThis project is licensed under the MIT License - [see the LICENSE file](LICENSE) for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmikeschulze%2Fgdunit4netexamples","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmikeschulze%2Fgdunit4netexamples","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmikeschulze%2Fgdunit4netexamples/lists"}