Update repository structure to reduce code duplication #1

Open
opened 2023-08-30 22:29:05 +02:00 by luca-pellegrini · 0 comments

Currently, the repository structure is quite messy, with a mixture of Bash scripts, Markdown and other plain text files at the root of the repository.

There's a lot of code duplication, since we have a set of scripts for Linux Mint (linuxmint-*.sh), a set for Fedora (fedora-*.sh) and one for Debian (debian-*.sh).

There's a reason for that: when I started this repository, I knew very little about Bash scripting, and about Linux in general. I just pasted in the commands which I usually had to type at the command line one by one.

Things to do to reduce code duplication and improve repository structure:

  • Move Bash scripts into a src subdirectory, and documentation files (in Markdown) into a docs subdirectory;
  • Refactor code: define functions in a common.sh file (a sort of header file), and source common.sh in the distro-specific scripts;
  • Translate source comments and documentation files in English;
Currently, the repository structure is quite messy, with a mixture of Bash scripts, Markdown and other plain text files at the root of the repository. There's a lot of code duplication, since we have a set of scripts for Linux Mint (`linuxmint-*.sh`), a set for Fedora (`fedora-*.sh`) and one for Debian (`debian-*.sh`). There's a reason for that: when I started this repository, I knew very little about Bash scripting, and about Linux in general. I just pasted in the commands which I usually had to type at the command line one by one. Things to do to reduce code duplication and improve repository structure: - [x] Move Bash scripts into a `src` subdirectory, and documentation files (in Markdown) into a `docs` subdirectory; - [ ] Refactor code: define functions in a `common.sh` file (a sort of header file), and source `common.sh` in the distro-specific scripts; - [ ] Translate source comments and documentation files in English;
luca-pellegrini self-assigned this 2023-08-30 22:30:13 +02:00
luca-pellegrini added the
enhancement
label 2023-08-30 22:34:36 +02:00
luca-pellegrini added reference update_repo_structure 2023-10-03 21:22:28 +02:00
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: luca-pellegrini/linux-setup#1
No description provided.