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

[docs] document the project's philosophy #81

Open
jameslamb opened this issue Oct 26, 2022 · 0 comments
Open

[docs] document the project's philosophy #81

jameslamb opened this issue Oct 26, 2022 · 0 comments
Labels
doc Improvements or additions to documentation

Comments

@jameslamb
Copy link
Owner

It might be useful to document some of the high-level design choices in this project, including explanations of why those choices were made.

For example:

  • any warnings being found result in a non-0 exit code
  • all checks are evaluated before exiting
  • all checks are accompanied by documentation explaining how to truly resolve them (not just how to get pydistcheck to stop reporting them)
  • pydistcheck is not a library...so nothing should be imported from it
  • dependencies are kept to an absolute minimum
  • no pydistcheck-specific configuration files
@jameslamb jameslamb added the doc Improvements or additions to documentation label Oct 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant