Skip to content
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.

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

Improve README and add subsequent documentation on current checks #26

Open
seanmarpo opened this issue Dec 16, 2020 · 0 comments
Open
Assignees
Labels
enhancement New feature or request

Comments

@seanmarpo
Copy link
Collaborator

Description

The README leaves a lot to be desired in terms of ease-of-use. Most notably, pipenv usage is inherently confusing to folks that haven't used it before.

Also, it would be nice to have docs specific to how the parts of CSRT work together for others that have an interest in improving the project.

Lastly, we need a doc that outlines the checks we currently perform and our relevant level of confidence in the check. This will provide the transparency needed for folks that want to incorporate this tooling into a build/test pipeline.

@seanmarpo seanmarpo added the enhancement New feature or request label Dec 16, 2020
@seanmarpo seanmarpo self-assigned this Dec 16, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant