Skip to content

Commit 39be4ce

Browse files
committed
feat(docs): update project documentation and assets
- Update README with modern layout, badges, and project structure - Add new brand assets (banner.jpg, tux.png, tux.ico) - Fix Discord invite links and update contact information - Enhance issue templates and security documentation - Update test scripts and helper functions - Improve project setup script (SETUP_TEMPLATE.sh) Security: Updated SECURITY.md with latest reporting guidelines Style: Applied consistent formatting across all modified files Refactor: Reorganized project structure for better maintainability This commit includes only documentation and non-functional changes. No sensitive data or credentials were exposed.
1 parent ace3df3 commit 39be4ce

12 files changed

Lines changed: 136 additions & 299 deletions

File tree

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
blank_issues_enabled: true
22
contact_links:
33
- name: Send an e-mail to the developer
4-
url: mailto:root.tuxtechlab@gmail.com
4+
url: mailto:admin@tuxtechlab.com
55
about: Please do NOT use this email to post issues or feature requests (only important business/personal contact).

README.md

Lines changed: 126 additions & 289 deletions
Large diffs are not rendered by default.

SECURITY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@ We appreciate your efforts to disclose your findings responsibly and will make e
66

77
To report a security issue, go to the project's issues and create a new issue using the ⚠️ Security Report 'issue template'.
88

9-
Read the instructions of this issue template carefully, and if your report could leak data or might expose how to gain access to a restricted area or break the system, please email [TuxTechLab.com](mailto:root.tuxtechlab@gmail.com) and include the word "SECURITY" in the subject line.
9+
Read the instructions of this issue template carefully, and if your report could leak data or might expose how to gain access to a restricted area or break the system, please email [TuxTechLab.com](mailto:admin@tuxtechlab.com) and include the word "SECURITY" in the subject line.
1010

1111
We'll endeavour to respond quickly and keep you updated throughout the process.

SETUP_TEMPLATE.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
# GITHUB: https://github.com/TuxTechLab/
2020
# REPOSITORY: https://github.com/TuxTechLab/TuxTechLab-Template-Repo
2121
# ISSUES: https://github.com/TuxTechLab/TuxTechLab-Template-Repo/issues
22-
# MAIL: root.tuxtechlab@gmail.com
22+
# MAIL: admin@tuxtechlab.com
2323
#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#
2424

2525
RED='\033[1;31m' # color red
@@ -209,7 +209,7 @@ y | Y)
209209

210210
# replace the username and email
211211
find .github/ -type f -name "*" -print0 | xargs -0 sed -i "s/TuxTechLab/${NEW_USERNAME}/g"
212-
find .github/ -type f -name "*" -print0 | xargs -0 sed -i "s/root.tuxtechlab@gmail.com/${NEW_EMAIL}/g"
212+
find .github/ -type f -name "*" -print0 | xargs -0 sed -i "s/admin@tuxtechlab.com/${NEW_EMAIL}/g"
213213
find .github/ -type f -name "*" -print0 | xargs -0 sed -i "s/project-template/${PROJECT_NAME}/g"
214214
find .gitignore -type f -name "*" -print0 | xargs -0 sed -i "s/TuxTechLab\/project-template/${NEW_USERNAME}\/${PROJECT_NAME}/g"
215215

bin/FUNCTION_HELPERS.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
# GITHUB: https://github.com/TuxTechLab/
1414
# REPOSITORY: https://github.com/TuxTechLab/TuxTechLab-Template-Repo
1515
# ISSUES: https://github.com/TuxTechLab/TuxTechLab-Template-Repo/issues
16-
# MAIL: root.tuxtechlab@gmail.com
16+
# MAIL: admin@tuxtechlab.com
1717
#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#
1818

1919
# SCRIPT WITH EXPORTED FUNCTIONS AND VARIABLES USED IN THE MAIN SETUP_TEMPLATE
@@ -64,7 +64,7 @@ displayHelpTexts() { # (it will manually detect your git data and prompt for the
6464
echo -e " bash $0"
6565
echo -e " bash $0 -h"
6666
echo -e " bash $0 --projectType=Angular-Website --omit-commit --omit-verification"
67-
echo -e " bash $0 --email=root.tuxtechlab@gmail.com"
67+
echo -e " bash $0 --email=admin@tuxtechlab.com"
6868
echo -e " bash $0 --username=whatever --projectName=whatever --email=whatever --projectType=whatever${NC}"
6969
echo -e " bash $0 -u=TuxTechLab --projectType=Github-template --omit-commit${NC}\n"
7070

src/assets/img/banner.jpg

856 KB
Loading

src/assets/img/tux.ico

197 KB
Binary file not shown.

src/assets/img/tux.png

129 KB
Loading

tests/TESTS_RUNNER.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
# GITHUB: https://github.com/TuxTechLab/
1313
# REPOSITORY: https://github.com/TuxTechLab/TuxTechLab-Template-Repo
1414
# ISSUES: https://github.com/TuxTechLab/TuxTechLab-Template-Repo/issues
15-
# MAIL: root.tuxtechlab@gmail.com
15+
# MAIL: admin@tuxtechlab.com
1616
#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#
1717

1818
LGREEN='\033[0;32m'

tests/argument_help_parser.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
# GITHUB: https://github.com/TuxTechLab/
1313
# REPOSITORY: https://github.com/TuxTechLab/TuxTechLab-Template-Repo
1414
# ISSUES: https://github.com/TuxTechLab/TuxTechLab-Template-Repo/issues
15-
# MAIL: root.tuxtechlab@gmail.com
15+
# MAIL: admin@tuxtechlab.com
1616
#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#~#
1717

1818
TESTS_TRASH_DIR="tests/.ignore.tests_trash"

0 commit comments

Comments
 (0)