rahuldkjain/github-profile-readme-generator

Add capability to verify each commit's sanity as per linter rules.

Open

#330 opened on Oct 31, 2020

View on GitHubContributor guide
 (2 comments) (0 reactions) (1 assignee)TypeScript (8,392 forks)batch import
enhancementhacktoberfestv1-deprecated

Repository metrics

Stars
 (24,395 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Is your feature request related to a problem? Please describe. Currently, while committing the code there is no eslint rules check. It would be good to enforce eslint rules on each git commit. That is when the eslint will run and block the user from committing code which is not as per the ESLint rules, so that the codebase is aligned to the rules configured.

Describe the solution you'd like We can use husky to make this possible. Before each commit husky will manage the enforcement of eslint rules.

Describe alternatives you've considered Let me know if there are better solutions for this issue available.

Additional context

Join the Discord Server for further discussions.

Server Link: https://discord.gg/HHMs7Eg

Contributor guide

Research direction
Investigate how to set up Husky and lint staged to run ESLint on staged files before commit.
Tech stack
javascript
Domain
tooling
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
GitJavaScriptnpm
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80