Bash-it/bash-it

Help us clean up Bash-it!

Open

#1,696 opened on Oct 31, 2020

View on GitHub
 (27 comments) (11 reactions) (0 assignees)Shell (2,304 forks)batch import
clean uphelp wanted

Repository metrics

Stars
 (15,045 stars)
PR merge metrics
 (Avg merge 4d 17h) (2 merged PRs in 30d)

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

Research direction
Review the list of files not in clean files.txt, pick one, add its path to clean files.txt, run ./lint clean files.sh, fix any linting errors, and open a PR. See example PR #1695 for reference. Ensure you have pre commit installed and configured.
Tech stack
shell
Domain
toolingdeveloper experience
Issue type
Chore
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.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Bash scriptingpre commit hooksGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70