{"id":21730129,"url":"https://github.com/nventive/gooseanalyzers","last_synced_at":"2026-05-13T05:41:41.130Z","repository":{"id":204001735,"uuid":"709803419","full_name":"nventive/GooseAnalyzers","owner":"nventive","description":".NET analyzers for your C# code","archived":false,"fork":false,"pushed_at":"2024-02-29T17:34:39.000Z","size":27,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-26T02:47:25.130Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nventive.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2023-10-25T12:36:55.000Z","updated_at":"2023-10-27T16:56:47.000Z","dependencies_parsed_at":null,"dependency_job_id":"6e8dc6ec-491f-4bd0-ba8f-3ee83c407b96","html_url":"https://github.com/nventive/GooseAnalyzers","commit_stats":null,"previous_names":["nventive/gooseanalyzers"],"tags_count":0,"template":false,"template_full_name":"nventive/Template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nventive%2FGooseAnalyzers","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nventive%2FGooseAnalyzers/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nventive%2FGooseAnalyzers/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nventive%2FGooseAnalyzers/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nventive","download_url":"https://codeload.github.com/nventive/GooseAnalyzers/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244706800,"owners_count":20496628,"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","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":[],"created_at":"2024-11-26T04:12:30.777Z","updated_at":"2026-05-13T05:41:41.069Z","avatar_url":"https://github.com/nventive.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# GooseAnalyzers\n\n[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=flat-square)](LICENSE) ![Version](https://img.shields.io/nuget/v/GooseAnalyzers?style=flat-square) ![Downloads](https://img.shields.io/nuget/dt/GooseAnalyzers?style=flat-square)\n\nGooseAnalyzers is a collection of .NET Analyzers for your C# code.\n\n## Getting Started\n\n1. Install the [`GooseAnalyzers`](https://www.nuget.org/packages/GooseAnalyzers) NuGet package in your project.\n\n1. Optionally, set `TreatWarningsAsErrors` to `true` when in `Release` configuration in your project files.\n   ```xml\n   \u003cTreatWarningsAsErrors Condition=\"'$(Configuration)'=='Release'\"\u003etrue\u003c/TreatWarningsAsErrors\u003e\n   ```\n   We recommend this so that you get warnings that don't block your dev loop, but errors that block your CI/CD pipelines.\n\n1. Review the list of analyzers below and adjust your project settings based on your preferences.\n\n## List of Analyzers\n\nIdentifier | Name | Description\n-|-|-\n`GOOSE001` | XmlDocumentationRequiredSuppressor | Limits the scope of [CS1591](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/compiler-messages/cs1591) and [SA1600](https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA1600.md) to interfaces.\n\n## Features\n\n### `GOOSE001` - XML Documentation on Interfaces\nThe `GOOSE001` analyzer is a `DiagnosticSuppressor` for the [CS1591](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/compiler-messages/cs1591) and [SA1600](https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA1600.md) rules that demand XML documentation on all public types and members.\nThis is a good practice, but it can unrealistic in some contexts. \nWe think that in those cases, having xml documentation on interfaces is a good middle ground.\n\n- If you typically disable the `CS1591` or `SA1600` rules, we recommend that the you enable them and use this suppressor to limit their scope to interfaces.\n- If you typically enable the `CS1591` or `SA1600` rules, we recommend that the you disable the `GOOSE001` suppressor.\n\n## Breaking Changes\n\nPlease consult [BREAKING_CHANGES.md](BREAKING_CHANGES.md) for more information about version\nhistory and compatibility.\n\n## License\n\nThis project is licensed under the Apache 2.0 license - see the\n[LICENSE](LICENSE) file for details.\n\n## Contributing\n\nPlease read [CONTRIBUTING.md](CONTRIBUTING.md) for details on the process for\ncontributing to this project.\n\nBe mindful of our [Code of Conduct](CODE_OF_CONDUCT.md).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnventive%2Fgooseanalyzers","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnventive%2Fgooseanalyzers","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnventive%2Fgooseanalyzers/lists"}