Skip to content

zanmstfa/opencheck

Repository files navigation

OpenCheck

CI License: MIT

OpenCheck gives public GitHub repositories a quick contribution-readiness check. Paste a repository URL and get a focused report showing what is ready for contributors and what could be improved next.

OpenCheck is guidance, not a verdict on project quality. It reads public data through the GitHub REST API and does not require a login or access token.

What OpenCheck checks

Each report looks for six practical signals:

  • A root README
  • An open-source LICENSE
  • A contribution guide
  • Issue templates
  • A pull request template
  • An open issue labeled good first issue

The six checks are combined into a readiness score. Missing items include a short next step, so the report stays useful instead of only showing a number.

Using OpenCheck

Enter any public GitHub repository using one of these formats:

https://github.com/owner/repository
github.com/owner/repository
owner/repository

OpenCheck does not support private repositories. Checks use GitHub's public API, so repeated requests may temporarily reach GitHub's unauthenticated rate limit.

Local development

OpenCheck requires Node.js ^20.19.0 or >=22.12.0.

git clone https://github.com/zanmstfa/opencheck.git
cd opencheck
npm install
npm run dev

The development server will print the local URL to open in your browser.

Testing and production build

Run the automated tests:

npm test

Create the production build:

npm run build

Both commands also run automatically for pull requests through GitHub Actions.

Contributing

Contributions are welcome. Read CONTRIBUTING.md for setup, branch, testing, and pull request guidance. Beginner-friendly tasks are marked with the good first issue label.

License

OpenCheck is available under the MIT License.

About

Check whether a public GitHub repository is ready to welcome open-source contributors.

Resources

License

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors