Skip to main content

Documentation for Contributors

Thanks for your interest in this NuGet package! Please follow the following steps if you want to contribute to the library.

  1. If you've never written a Roslyn analyzer or a code fix provider before, please follow the official tutorial.

  2. File an issue or comment on an existing ticket you're interested in.

  3. Tag @Bartleby2718 and align on the list of tests and the release branch to branch off of.

  4. Branch off from the suggested branch and file a PR into that branch.

    Each PR should tackle one problem, whether it's updating documentation, fixing a bug, or adding/updating a pair of analyzer and a code fix provider.

    When adding a new pair of analyzer and a code fix provider, please see Shimmering.Analyzers.Scaffolding/README.md to kickstart your development.

Special thanks for @matthew-elgart for brainstorming with me and reviewing PRs!