sporada/lug-helper
1
0
Fork 0
mirror of https://github.com/the-sane/lug-helper.git synced 2025-08-14 06:33:28 +00:00
Code Issues Projects Releases Wiki Activity

Update headings

Browse Source
This commit is contained in:
the Sane.
2025-08-12 14:40:27 -04:00
committed by GitHub
parent 73d19e3b54
commit 48e850d23b
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
.github/CONTRIBUTING.md vendored
View File

@@ -1,17 +1,17 @@
# Contributors' Guide # Contributor's Guide
## Project Goals ### Project Goals
The LUG Helper is a purpose-built bash script for the [Star Citizen Linux Users Group](https://wiki.starcitizen-lug.org/). Our community is a diverse group of Penguins running many differnet Linux distros on all kinds of hardware. As such, ease of use and compatibility are primary focuses of the project. The LUG Helper is a purpose-built bash script for the [Star Citizen Linux Users Group](https://wiki.starcitizen-lug.org/). Our community is a diverse group of Penguins running many differnet Linux distros on all kinds of hardware. As such, ease of use and compatibility are primary focuses of the project.
The Helper is designed to be easy and intuitive for novice Penguins who may be using Linux for the very first time. It clearly communicates to the user what is being done and aims to provide working defaults without overwhelming the user with too many unnecessary choices. The Helper is designed to be easy and intuitive for novice Penguins who may be using Linux for the very first time. It clearly communicates to the user what is being done and aims to provide working defaults without overwhelming the user with too many unnecessary choices.
## Pull Request Guidelines ### Pull Request Guidelines
With the above project goals in mind, please consider the following guidelines when submitting Pull Requests: With the above project goals in mind, please consider the following guidelines when submitting Pull Requests:
- Avoid overwhelming the user with choices and, instead, provide defaults that "Just Work". - Avoid overwhelming the user with choices and, instead, provide defaults that "Just Work".
- Any messages or options presented to the user should be clear and concise. - Any messages or options presented to the user should be clear and concise.
- The Helper should not make any changes to the user's system without first asking or notifying the user. - The Helper should not make any changes to the user's system without first asking or notifying the user.
- Avoid duplicating code. Make use of the existing helper functions. See Code Structure and Overview below. - Avoid duplicating code. Make use of the existing helper functions. See Code Structure and Overview below.
## Code Syntax and Formatting Guidelines ### Code Syntax and Formatting Guidelines
- Match existing code styling and syntax for consistency and legibility. - Match existing code styling and syntax for consistency and legibility.
- Stick to POSIX-compliant code where possible for portability. - Stick to POSIX-compliant code where possible for portability.
- Where bashisms are necessary for functionality or because they vastly simplify code maintenance, check in which bash version the feature was introduced to make sure the code will work on older LTS distros. - Where bashisms are necessary for functionality or because they vastly simplify code maintenance, check in which bash version the feature was introduced to make sure the code will work on older LTS distros.
@@ -21,7 +21,7 @@ With the above project goals in mind, please consider the following guidelines w
# Code Structure and Overview # Code Structure and Overview
The following is a high level overview of the Helper's functions as of LUG Helper Version 4.3 What follows is a high level overview of the Helper's functions as of LUG Helper Version 4.3
## Setup ## Setup
The setup portion at the top of the script: The setup portion at the top of the script: