WorldHealthOrganization/app

git pre-commit hooks + basic config

Open

#1,671 opened on Oct 26, 2020

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Dart (523 forks)batch import
dev-workflowgood first issueideasource:team

Repository metrics

Stars
 (2,118 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Summary

Add basic pre-commit hooks to the repo. To catch, for example, broken symlinks (https://github.com/WorldHealthOrganization/app/pull/1670) Link: https://github.com/pre-commit/pre-commit-hooks

Possible config file. Should be run against every file in the existing tree to see what issues might come up.

# .pre-commit-config.yaml
-   repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v3.3.0  # Use the ref you want to point at
    hooks:
    -   id: trailing-whitespace
    -   id: check-added-large-files
    -   id: check-case-conflict
    -   id: check-executables-have-shebangs
    -   id: check-json
    -   id: check-symlinks
    -   id: detect-private-key
    -   id: end-of-file-fixer

Checklist:

Contributor guide

Research direction
Read the pre commit hooks documentation, add the .pre commit config.yaml file as shown, and run 'pre commit run all files' to identify and fix any issues.
Tech stack
dart
Domain
devops
Issue type
Chore
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90