Skip to content

Properly document PSSA2 #1487

Open
Open
@rjmholt

Description

@rjmholt

PSSA2 should have full documentation. This includes:

  • Descriptive code comments that can be used to provide API documentation for consumers
  • Documentation of all rules
  • Documentation of configuration and how to configure and run for users
  • Documentation on rule suppression
  • Documentation on hosting
  • Documentation on implementing a rule in both .NET and PS script
  • Documentation on the project's architecture
  • A full README on how to build, run and contribute

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions