ElementsProject / ElementsProject/lightning

Perform basic conventional checks in Git pre-commit hook

Open
#7,765 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
C
Stars
3.1k
Forks
1k
Avg merge
4d 10h
Merged PRs (30d)
13

Description

Following from [this](https://discord.com/channels/899980449231814676/899989708065632276/1299400269695553546) conversation on Discord, @cdecker writes:

> Sure, there are plenty of pre-commit plugins for that type of lint. A quick search surfaced https://github.com/compilerla/conventional-pre-commit for example.
I also wonder if we should remove some of our custom tooling in favor of better maintained conventional tools (shellcheck run, JSON schema format check, JSON schema validation, check that files were regenerated when needed, etc. currently there are loads of make targets that just check something in ci, when really we want to enforce them for new code. The upside would be that we check during commit, but the same rules can just be double checked in ci from the same config.

This issue represents the beginning of an initiative to improve standardization and offload some of the CI checks into the developer workflow, starting with the following brainstorm:
- [ ] shellcheck run
- [ ] JSON schema format check
- [ ] Check regenerated files
- [ ] lint commit messages and validate against accepted conventions
- [x] Python linting

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.