OpenRefine / OpenRefine/OpenRefine
Move linting from CI to a Git hook
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 12k
- Forks
- 2.2k
- Avg merge
- 1d 14h
- Merged PRs (30d)
- 27
Description
Rather than to prompt the developer about linting issues post CI and then having them fix the issues we could always run the formatter prior to a commit for a better developer experience.
This would be especially benefit for work that goes on in branches for a while before reaching master, for newcomers, and for people outside of the OpenRefine org as they do not trigger CI automatically.
As a bonus it would speed up CI.
A downside would be that in addition to git clone users would need to run git config to get started developing.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the existing CI linting configuration and the repository's development setup; the issue names no files or tests. Determine how a Git hook and git config would run the formatter before commits, preserve a workable clone/setup path, and remove or reduce the corresponding CI linting work.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- git, java
- Domain
- ci-cd, developer-experience, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100