Bash-it / Bash-it/bash-it

Help us clean up Bash-it!

Open
#1,696 27 comments 11 reactions 0 assignees View on GitHub
clean up help wanted
Dominant language
Shell
Stars
15.2k
Forks
2.3k
Avg merge
7d 1h
Merged PRs (30d)
2

Description

Hello folks!
We have now integrated `pre-commit` hooks in order to improve the codebase quality. and now we need to start going through the files. We invite anyone who wants to contribute to this effort to try this out:
* Choose a file in the project, which is not present in `clean_files.txt`
* Add the path from the root of the project to the file in `clean_files.txt`
* Run ``./lint_clean_files.sh``, and fix the issues
* When `pre-commit` runs successfully, feel free to open a PR
* Hooray, you helped us make Bash-it better! :smile:

An example PR, would be #1695

Contributor guide

Open the contributing guide

Research direction

Choose a project file not listed in clean_files.txt, then read the instructions in the issue and run ./lint_clean_files.sh. Use the pre-commit hooks to identify and fix that file's issues; the work is done when pre-commit succeeds and the cleaned file can be submitted in a PR.

Written by the indexing model from the issue text.

Assessment

Tech stack
bash, shell
Domain
testing, tooling
Issue type
Refactor
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.