From 3e75b4b73b9b53cf08af691ea5dbc1bd2dc74d56 Mon Sep 17 00:00:00 2001 From: Josee9988 Date: Sat, 10 Jul 2021 14:31:18 +0200 Subject: [PATCH] "documented the changes" --- CHANGELOG.md | 30 +++++++++++++++++++++++------- README.md | 30 +++++++++++++++--------------- SETUP_TEMPLATE.sh | 2 +- 3 files changed, 39 insertions(+), 23 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index cf9f4de..8ed8faf 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,13 +7,29 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) --- +## [**1.8.1**] - 2021-07-10 + +### Added + +* Basic file documentation for all the tests. +* Improved the TESTS_RUNNER script. + +### Fixed + +* Some minor typos. +* The README's project tree + +### Changed + +* The comment 'BASH_VERSION' in all the scripts to the actual one. + ## [**1.8.0**] - 2021-07-09 ### Added * Multiple bash unit tests. * The SETUP_TEMPLATE.sh now takes a 4th argument which is the type of the project. -* Updated the README to add the new tests documentation +* Updated the README to add the documentation of the new test ### Fixed @@ -32,15 +48,15 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) ### Fixed -* Minnor typo in the generated README.md +* Minor typo in the generated README.md ## [**1.7.1**] - 2021-07-01 ### Added * `.env` file will be ignored in the `.gitignore`. -* Disabled some markdownlint rules in the generated README.md -* Fixed some minnor errors in the README.md file +* Disabled some markdown link rules in the generated README.md +* Fixed some minor errors in the README.md file ## [**1.7.0**] - 2021-06-01 @@ -48,13 +64,13 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) * Type: Test issue label. * Failing test issue template adds the new Type Test issue label. -* Updated README.md with the new label. +* Update README.md with the new label. ## [**1.6.0**] - 2021-05-21 ### Added -* Divided the feature request into feature and enhancement request, each one with its respective labels. +* Divided the feature request into feature and enhancement requests, each one with its respective labels. ### Changed @@ -130,7 +146,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) ### Fixed -* Some README.md markdownlint bugs. +* Some README.md markdown link bugs. ## [**1.2.0**] - 2021-04-07 diff --git a/README.md b/README.md index c88a78d..47ffe44 100644 --- a/README.md +++ b/README.md @@ -95,14 +95,14 @@ Files that will get removed after the execution of `SETUP_TEMPLATE.sh` are not s . ├── CHANGELOG.md ├── .github -│   ├── CODE_OF_CONDUCT.md -│   ├── CODEOWNERS -│   ├── CONTRIBUTING.md -│   ├── FUNDING.yml -│   ├── issue_label_bot.yaml -│   ├── config.yml -│   ├── ISSUE_TEMPLATE -│   │   ├── 1-bug-report.md +│ ├── CODE_OF_CONDUCT.md +│ ├── CODEOWNERS +│ ├── config.yml +│ ├── CONTRIBUTING.md +│ ├── FUNDING.yml +│ ├── issue_label_bot.yaml +│ ├── ISSUE_TEMPLATE +│ │ ├── 1-bug-report.md │ │ ├── 2-failing-test.md │ │ ├── 3-docs-bug.md │ │ ├── 4-feature-request.md @@ -110,15 +110,15 @@ Files that will get removed after the execution of `SETUP_TEMPLATE.sh` are not s │ │ ├── 6-security-report.md │ │ ├── 7-question-support.md │ │ └── config.yml -│   ├── ISSUE_TEMPLATE.md -│   ├── pull_request_template.md -│   ├── SECURITY.md -│   ├── settings.yml -│   └── SUPPORT.md +│ ├── ISSUE_TEMPLATE.md +│ ├── pull_request_template.md +│ ├── SECURITY.md +│ ├── settings.yml +│ └── SUPPORT.md ├── .gitignore └── README.md -2 directories, 21 files +2 directories, 22 files ``` --- @@ -173,7 +173,7 @@ Badges and texts will be replaced with your project details! ### 🔖 The labels for your issues -If the bot [probot-settings](https://probot.github.io/apps/settings/) is not installed you will not have these beautiful labels! (there are actually 1 more issue label than in the screenshot!) +If the bot [probot-settings](https://probot.github.io/apps/settings/) is not installed you will not have these beautiful labels! (there are actually more issue labels than in the image!)

LABELS diff --git a/SETUP_TEMPLATE.sh b/SETUP_TEMPLATE.sh index 088dc07..0a25c09 100644 --- a/SETUP_TEMPLATE.sh +++ b/SETUP_TEMPLATE.sh @@ -14,7 +14,7 @@ # VERSION: See in CHANGELOG.md # NOTES: This script will auto remove itself, and in case of wanting to run it again, the user must download # it again or do a 'git stash' and revert the changes. -# BASH_VERSION: 5.0.17(1)-release +# BASH_VERSION: 5.1.4(1)-release (x86_64-pc-linux-gnu) # LICENSE: see in LICENSE (project root) or https://github.com/Josee9988/project-template/blob/master/LICENSE # GITHUB: https://github.com/Josee9988/ # REPOSITORY: https://github.com/Josee9988/project-template