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

Add a QA sub #37

Open
1 of 21 tasks
Tyil opened this issue Apr 23, 2018 · 0 comments · May be fixed by #38
Open
1 of 21 tasks

Add a QA sub #37

Tyil opened this issue Apr 23, 2018 · 0 comments · May be fixed by #38

Comments

@Tyil
Copy link
Member

Tyil commented Apr 23, 2018

This sub would run various quality assurance checks on a module source to report what a module could use to improve its release. See Release::Checklist for some prior art. Some things to check for include:

  • Good module name (first-level namespaces are generally bad)
  • Tests
    • Are there tests
    • Do the tests succeed
  • Does installation of the module succeed
  • Documentation
    • A README with
      • Synopsis
      • Examples
      • Copyright information
    • A correct META6.json
      • Presence of some optional but useful fields
      • No unused dependencies
      • Dependency version adverbs
      • Version using a SemVer capable approach
        (I understand not everyone is a huge fan of it as I am, but I've yet to find a better versioning scheme, and assixt can be a little opinionated on its QA. If there are better schemes out there, I'd like to hear, though.)
    • POD blocks for each sub and argument
  • Clean tree
    • Use version control to check for lingering files
  • Tree meta files
    • Check for a CHANGELOG
    • Check for a LICENSE
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant