Properly document PSSA2 #1487

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Open

rjmholt opened this issue May 6, 2020 · 0 comments

Labels

Milestone

Contributor

rjmholt commented May 6, 2020

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

rjmholt added the Consider - 2.0 label

rjmholt added this to the 2.0 milestone

ghost added the Needs: Triage 🔍 label

rjmholt removed the Needs: Triage 🔍 label

SydneyhSmith mentioned this issue

PSSA 2.0 Roadmap #1528

Open

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment