HiveMinds / HiveMinds/Productivity-setup

Make code shellcheck compliant

Open
#15 1 comment 0 reactions 0 assignees View on GitHub
good first issue
Dominant language
Shell
Stars
3
Forks
4
PR merge metrics
No merged PRs in 30d

Description

Cool that you're having a look! Shellcheck is a code-formatting tool meaning it tells you what should be improved about your code style, a bit like python black, except not automated. To use shellcheck you can: sudo apt install shellcheck (on windows you first have to get the WSL app from the store to do that), then you can simply run the shellcheck by cloning this repository and running the shellcheck command from the root directory of this repository. For example:


cd /home/a/

git clone https://github.com/HiveMinds-EU/Productivity-setup.git
cd Productivity-setup
shellcheck -x <filepath>






where the filepath is the relative path to the file your improving, e.g.:


shellcheck -x src/apt_7_0_enable_apt_https_support.sh







Then shellcheck displays the things that could be improved, and tells you how to do that, then you can improve them and run it again, untill shellcheck is silenced for that file. An example that solves the last "shellcheck issue" on line 83 is displayed in the video below:

Alt Text


Here is the list of file todo:


Root directory:






  • test.sh

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the root-level test.sh named in the checklist, then run shellcheck -x test.sh from the repository root. Review each reported issue and rerun ShellCheck after changes; done means the file is silent, while preserving its existing setup behavior.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.