Skip to content

Latest commit

 

History

History
12 lines (11 loc) · 1.54 KB

CONTRIBUTING.md

File metadata and controls

12 lines (11 loc) · 1.54 KB
Raw

Contributing

  • Pick an analyzer not assigned to anyone from the todo column of our project board - or feel free to propose a new one.
    • For a new analyzer, create a new issue with the title in the format "AG0XXX: My analyzer title" and add the "New rule" label.
    • Ensure your new analyzer uses a DiagnosticID (eg. AG0XXX) that is not already assigned. If in doubt, see existing issues (open and closed) to determine the next free ID.
  • Assign the issue to yourself and move it to the "In Progress" column on our project board.
  • Create a PR and tag the original issue number in the description (eg. "Closes #31"). Your PR should contain:
    • Your analyzer.
    • Unit tests (example).
    • An HTML description of the analyzer, including what it checks for, why it does it, and compliant and non-compliant code snippets (example).
    • A corresponding automatic Code Fix, if appropriate and you are feeling adventurous (example).
  • Please limit the changes contained in your PR to a single issue.