defenseunicorns/pepr-excellent-examples

Add husky-based commit linting to project

Open

#186 opened on Oct 29, 2024

View on GitHub
 (0 comments) (0 reactions) (0 assignees)TypeScript (0 forks)auto 404
good first issue

Repository metrics

Stars
 (9 stars)
PR merge metrics
 (PR metrics pending)

Description

Describe what should be investigated or refactored

  1. Introduce eslint to this project (if it's not already there), and

  2. Add an husky-based, eslint-running pre-commit hook to the project ( which should mirror the functionality that was recently implemented in the Pepr project).

Links to any relevant code

Pepr Husky config: https://github.com/defenseunicorns/pepr/tree/main/.husky Husky config origin PR: https://github.com/defenseunicorns/pepr/pull/1113 Husky config update PR: https://github.com/defenseunicorns/pepr/pull/1167/files

Contributor guide

Research direction
Follow the Pepr Husky configuration as a template. Set up eslint configuration if missing, then add Husky pre commit hook that runs eslint.
Tech stack
typescript
Domain
developer experience
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Gitnpm
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75