RepoAuditor 0.4.6

Add your description here

RepoAuditor - README

Project:

Package:

Development:

Overview

RepoAuditor is a tool which audits repositories for best practices.

If you're running an open-source repository, there are many steps involved in being open-source beyond making your repository public.

In order to make your repository both friendly to maintainers and contributors, you will want to enable/disable some settings (e.g. require reviews, status checks pass), or you may be missing certains files (like LICENSE or CODE_OF_CONDUCT) that prevent adoption of your project.

RepoAuditor can check and audit your repository so that all the right settings and content are available to make your open-source repository high-quality, even if you are new to maintaining one.

E.g. check if various files for maintaining community standards are available:

uvx repoauditor --include CommunityStandards \
    --CommunityStandards-url https://github.com/gt-sse-center/RepoAuditor \
    --verbose

This will check if your open-source repository has files like a License, Code of Conduct, README, Code Owners, etc.

We have set RepoAuditor to have defaults which match with best practices in open-source communities, however they can all be overrided.

For more information on how to use RepoAuditor and its available features, please refer to the documentation below.

Documentation

Please refer to the documentation hosted here.

Development

Please visit Contributing and Development for information on contributing to this project.

Additional Information

Additional information can be found at these locations.

Title	Document	Description
Code of Conduct	CODE_OF_CONDUCT.md	Information about the norms, rules, and responsibilities we adhere to when participating in this open source community.
Contributing	CONTRIBUTING.md	Information about contributing to this project.
Development	DEVELOPMENT.md	Information about development activities involved in making changes to this project.
Governance	GOVERNANCE.md	Information about how this project is governed.
Maintainers	MAINTAINERS.md	Information about individuals who maintain this project.
Security	SECURITY.md	Information about how to privately report security issues associated with this project.

License

RepoAuditor is licensed under the MIT license.