Skip to content

Latest commit

 

History

3 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

RepoReady

RepoReady is a dependency-free Python command-line tool that checks whether an open-source repository has the basic files contributors expect.

It looks for a README, license, contribution guide, code of conduct, security policy, pull-request template, issue templates, and at least one test.

Install

python -m pip install .

Use

repoready .
repoready /path/to/repository --format markdown
repoready . --format json

A non-zero exit code means that at least one check still needs attention, which makes the command suitable for local quality gates.

Why this exists

A project can be small and still be easy to understand and contribute to. RepoReady makes the first round of repository hygiene visible in seconds.

Development

python -m unittest discover -s tests -v

Support

If this project helps you, you can support its continued development.

  • USDT — BEP20 / BNB Smart Chain: 0x9ee9a9ef2b9679fa99b3b36313bc581a66b05cfb
  • Bitcoin — BTC mainnet: bc1qsg09m3yj4d8d026ayfhhazu823h8vntu8wph95

Please send funds only on the stated network. Never send a seed phrase or private key.

About

A small CLI that audits open-source repository health.

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages