https://github.com/jefeish/repo-hygiene
A GitHub App for enforcing repository best practices that ensure security, code quality, and optimal project hygiene.
https://github.com/jefeish/repo-hygiene
Last synced: 2 months ago
JSON representation
A GitHub App for enforcing repository best practices that ensure security, code quality, and optimal project hygiene.
- Host: GitHub
- URL: https://github.com/jefeish/repo-hygiene
- Owner: jefeish
- License: mit
- Created: 2023-06-08T10:16:53.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-16T00:58:53.000Z (over 1 year ago)
- Last Synced: 2025-02-01T16:27:35.051Z (4 months ago)
- Language: JavaScript
- Homepage:
- Size: 2.61 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Repo-Hygiene
Repository practices that maintain cleanliness, health, or optimal conditions.
> An App based solution, if GitHub Actions are not an option.
---
## Initial areas of Repo-Hygiene compliance checks
- Repo size (total)
- Number of branches
- Number of stale branches
- Large files
- Number of open PRs
- Number of Dependabot alerts
---
## Individual Checks
### Input format
>Note: the input values/format are individual for each check and only require certain mandatory fields.
**Sample**
```yaml
checks:
# Name of the compliance check (required)
- check: number_of_branches
# impact on overall results (required)
weight: 0.5
# custom fields ...
params:
threshold: 20
severity: warning
message: Number of Branches exceeded
```
### Output format
This needs to be 'normalized' in order to create an overall score based report
**Sample**
```yaml
check:
name: number_of_branches
score: 8
status: pass
message: The number of branches are < 5 as required
```
>Note: The App should be triggered on a PR and check the Repo for hygiene policy compliance.
If the Repo fails the compliance conditions, a check run failure will be set.