3

Standards

Joey Turner edited this page 2024-09-16 10:49:30 -05:00

Table of Contents

• Categories
• Function Naming Convention
• Admin sudo user
• main function groups system and security
• Non Admin non sudo
• user space, end-user Customization
• Help message format
• Existing Example

Categories

• Network Software: Software related to network management (e.g., Wi-Fi, VPN) should be placed in config.ng.network.sh.
• System Software: This includes core system tools or utilities like kernel updates or driver installations and belongs in config.ng.system.sh.
• Third-Party Software: Any non-system software, such as user-installed applications (e.g., development tools, media players), should go in config.ng.software.sh.
• Localization: Functions related to configuring language settings, locale, time zone, or keyboard layouts should be placed in config.ng.localization.sh.

Function Naming Convention

Naming convention for functions:

Admin sudo user

main function groups system and security

• see_: used for retrieving or viewing values apt-cashe grep something ls -h cat file.txt lsblk
• set_: used for setting or updating values echo "somevalue" > somefile.txt
• get_: used for getting downloads or updates apt-get install something
• rem_: used for removing or uninstalling something apt-get purge something

Non Admin non sudo

user space, end-user Customization

• run_: used for running apps in the user space /usr/bin/chromium --kiosk https://forum.armbian.com/ https://github.com/armbian/configng &
• mod_: used for modifying or getting something in user space git clone wget

Please use these prefixes consistently when naming functions in this project.

Help message format

Existing Example

• ls --help Shows advanced flag options
• p7zip -h Shows simple flag options
• git --help Shows advanced non flag options