Date: Wed, 31 Mar 2021 15:40:01 +0200
Subject: [PATCH 059/152] "improved readme documentation"
---
CHANGELOG.md | 4 ++++
README.md | 11 ++++++-----
2 files changed, 10 insertions(+), 5 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 7b6580e..23e5252 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -21,6 +21,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
### Fixed
+* Git status is shown before the commit.
+
+### Fixed
+
* Some typos in the CHANGELOG.md.
## [**1.0.11**] - 2021-03-20
diff --git a/README.md b/README.md
index 0a11195..ec1a944 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,5 @@
-# **Josee9988's Github Project Template** π₯
+# π₯ **Josee9988's Github Project Template**
@@ -29,7 +29,7 @@ clone your new repository and execute the `SETUP_TEMPLATE.sh` shell script to pe
---
-## π **How to use it as a template for my new repositories?**
+## β‘ **Installation**
1. To create a new repository from this template [generate your new repository from this template](https://github.com/Josee9988/project-template/generate)
for more information or guidance, follow the [Github guide](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template).
@@ -58,9 +58,10 @@ for more information or guidance, follow the [Github guide](https://docs.github.
## π **What does it include?**
1. A **`SETUP_TEMPLATE.sh`** script that **MUST be executed right when you clone your repository**.
-The script will replace Jose's username and email (the author) with yours.
-It will remove all the _content_ from the CHANGELOG.md and write the basic structure for you to write your own.
-The script will also remove all the _content_ from the READMiframea sponsor button (should be manually modified). [Learn more with the Github guide](https://docs.github.com/en/github/administering-a-repository/displaying-a-sponsor-button-in-your-repository)
+The script will replace Jose's username and email (the author) with yours from all the.
+
+ 1. A README template file with a default template to start documenting your project.
+ 1. A CHANGELOG template file based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
1. An [issue_label_bot.yaml](/.github/issue_label_bot.yaml) file to use the popular Github bot. [Activate it or check its documentation](https://github.com/marketplace/issue-label-bot).
1. A [CONTRIBUTING](/.github/CONTRIBUTING.md) explaining how to contribute to the project. [Learn more with the Github guide](https://docs.github.com/en/github/building-a-strong-community/setting-guidelines-for-repository-contributors).
1. A [SUPPORT](/.github/SUPPORT.md) explaining how to support the project. [Learn more with the Github guide](https://docs.github.com/en/github/building-a-strong-community/adding-support-resources-to-your-project).
From 0ff80d6826e2b6e246e2c042161506010a99af51 Mon Sep 17 00:00:00 2001
From: Josee9988
Date: Wed, 31 Mar 2021 15:44:05 +0200
Subject: [PATCH 060/152] "added images about the new readme and changelog
template"
---
README.md | 10 ++++++++++
1 file changed, 10 insertions(+)
diff --git a/README.md b/README.md
index ec1a944..5956470 100644
--- a/README.md
+++ b/README.md
@@ -139,6 +139,16 @@ A couple of screenshots to delight you before you use this template.
+* The README template.
+
+
+
+
+* The CHANGELOG template.
+
+
+
+
* Security policy
From b8f9428d4b26fa3cebc37c9a905f28c971b0503f Mon Sep 17 00:00:00 2001
From: Josee9988
Date: Wed, 31 Mar 2021 15:45:35 +0200
Subject: [PATCH 061/152] "removed type of change in the PRS as this was so
annoying"
---
.github/pull_request_template.md | 10 ----------
1 file changed, 10 deletions(-)
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index f768058..7177e1e 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -13,16 +13,6 @@ List any dependencies that are required for this change if there are any.
---
-### **Type of change**
-
-
-
-* [] **Bug fix** (non-breaking change which fixes an issue).
-* [] **Enhancement** (non-breaking change which adds functionality).
-* [] **Breaking change** (fix or feature that would cause existing functionality to not work as expected).
-* [] This change requires a documentation update.
-* [] Other.
-
---
### **Additional context**
From 68d172f0f2a551b6e1e140337fd1a02524144005 Mon Sep 17 00:00:00 2001
From: Josee9988
Date: Wed, 31 Mar 2021 15:46:44 +0200
Subject: [PATCH 062/152] "removed extra space in the pr template"
---
.github/pull_request_template.md | 2 --
1 file changed, 2 deletions(-)
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index 7177e1e..8d31ec6 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -13,8 +13,6 @@ List any dependencies that are required for this change if there are any.
---
----
-
### **Additional context**
From 257a6d1239de02bca167bcfb3e5085acb898070a Mon Sep 17 00:00:00 2001
From: Josee9988
Date: Wed, 31 Mar 2021 20:35:41 +0200
Subject: [PATCH 063/152] "minnor fixes"
---
SETUP_TEMPLATE.sh | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/SETUP_TEMPLATE.sh b/SETUP_TEMPLATE.sh
index 7c38ff8..c9c517a 100644
--- a/SETUP_TEMPLATE.sh
+++ b/SETUP_TEMPLATE.sh
@@ -84,12 +84,13 @@ y | Y)
echo -e "# add your own funding links" >.github/FUNDING.yml
# commit the new files
- git add CHANGELOG.md README.md .gitignore .github SETUP_TEMPLATE.sh LICENSE
+ git add CHANGELOG.md README.md .gitignore .github SETUP_TEMPLATE.sh LICENSE bin
git -c color.status=always status | less -REX # show git status with colours
+
echo -e "Commiting the changes for you :)\n"
- git commit -m "Set up Josee9988's template: Personalized files by executing the SETUP_TEMPLATE.sh script."
+ git commit -m "Set up 'Josee9988/project-template' template: Personalized files by executing the SETUP_TEMPLATE.sh script.π"
echo -e "\nRemember to review every file and customize it as you like.\nYou are ready to start your brand new awesome projectππ."
From 5b958820438d11b6bab5d640465eafbcb0b43e8f Mon Sep 17 00:00:00 2001
From: Josee9988
Date: Wed, 31 Mar 2021 21:16:04 +0200
Subject: [PATCH 064/152] "added readme badges"
---
SETUP_TEMPLATE.sh | 4 ++--
bin/FUNCTION_HELPERS.sh | 23 ++++++++++++++++++++++-
2 files changed, 24 insertions(+), 3 deletions(-)
diff --git a/SETUP_TEMPLATE.sh b/SETUP_TEMPLATE.sh
index c9c517a..bc26374 100644
--- a/SETUP_TEMPLATE.sh
+++ b/SETUP_TEMPLATE.sh
@@ -54,9 +54,9 @@ else
fi
# prompt for the username, mail and name of the project
-read -p "Enter your $(echo -e "$BBLUE""username""$NC") (without '@'): " NEW_USERNAME
+read -p "Enter your $(echo -e "$BBLUE""Github username""$NC") (without '@'): " NEW_USERNAME
read -p "Enter your $(echo -e "$BBLUE""email""$NC"): " NEW_EMAIL
-read -p "Enter the $(echo -e "$BBLUE""name of the project""$NC"): " PROJECT_NAME
+read -p "Enter the name of the $(echo -e "$BBLUE""Github's project""$NC"): " PROJECT_NAME
read -p "Enter $(echo -e "$BBLUE""what your project is""$NC") (program/extension/API/web/CLI tool/backend/frontend/scrapper/automation tool/etc): " PROJECT_TYPE
# confirm that the data is correct
diff --git a/bin/FUNCTION_HELPERS.sh b/bin/FUNCTION_HELPERS.sh
index 093222e..08e657f 100644
--- a/bin/FUNCTION_HELPERS.sh
+++ b/bin/FUNCTION_HELPERS.sh
@@ -3,10 +3,19 @@
# SCRIPT WITH EXPORTED FUNCTIONS AND VARIABLES
writeREADME() {
- bash -c "NEW_USERNAME='NEW_USERNAME' PROJECT_NAME='PROJECT_NAME'; cat << EOF > README.md
+ bash -c "NEW_USERNAME='NEW_USERNAME' PROJECT_NAME='PROJECT_NAME' PROJECT_TYPE='PROJECT_TYPE'; cat << EOF > README.md
# π₯ **$NEW_USERNAME/$PROJECT_NAME**
+
+
+
+
+
+
+
+
+
---
# β‘ **Getting started**
@@ -38,6 +47,18 @@ Watch the changes in the **[CHANGELOG.md](CHANGELOG.md)** file.
This project was generated using *[Josee9988/project-template](https://github.com/Josee9988/project-template)* π
+---
+
+## π Was the $PROJECT_TYPE helpful? Help us raise these numbers up
+
+[![Github followers](https://img.shields.io/github/followers/$NEW_USERNAME.svg?style=social)](https://github.com/$NEW_USERNAME)
+[![Github stars](https://img.shields.io/github/stars/$NEW_USERNAME/$PROJECT_NAME.svg?style=social)](https://github.com/$NEW_USERNAME/$PROJECT_NAME/stargazers)
+[![Github watchers](https://img.shields.io/github/watchers/$NEW_USERNAME/$PROJECT_NAME.svg?style=social)](https://github.com/$NEW_USERNAME/$PROJECT_NAME/watchers)
+[![Github forks](https://img.shields.io/github/forks/$NEW_USERNAME/$PROJECT_NAME.svg?style=social)](https://github.com/$NEW_USERNAME/$PROJECT_NAME/network/members)
+[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=github-sponsors&color=red&style=social)](https://github.com/sponsors/$NEW_USERNAME)
+
+Enjoy! π
+
_Made with a lot of β€οΈβ€οΈ by **[@$NEW_USERNAME](https://github.com/$NEW_USERNAME)**_
EOF"
}
From 26c39b4c02674c1050faaaa16f8dee587f905840 Mon Sep 17 00:00:00 2001
From: Josee9988
Date: Thu, 1 Apr 2021 18:33:09 +0200
Subject: [PATCH 065/152] "documented the readme with the new badges feature"
---
README.md | 11 ++++++-----
1 file changed, 6 insertions(+), 5 deletions(-)
diff --git a/README.md b/README.md
index 5956470..c78554c 100644
--- a/README.md
+++ b/README.md
@@ -21,6 +21,7 @@
* This template can be used as a base layer for any of your future repositories/projects.
* Make your project easy to maintain with **7 issue templates**.
+* Quickstart your documentation with **badges** and a cool readme structure.
* Make your _community healthier_ with all the guides like code of conduct, contributing, support, security...
* Learn more with the [official Github guide on creating repositories from a template](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template).
* To start using it; "**[click use this template](https://github.com/Josee9988/project-template/generate)**", create your new repository,
@@ -60,7 +61,7 @@ for more information or guidance, follow the [Github guide](https://docs.github.
1. A **`SETUP_TEMPLATE.sh`** script that **MUST be executed right when you clone your repository**.
The script will replace Jose's username and email (the author) with yours from all the.
- 1. A README template file with a default template to start documenting your project.
+ 1. A README template file with a default template to start documenting your project. (it includes personalized badges and text with your project details)
1. A CHANGELOG template file based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
1. An [issue_label_bot.yaml](/.github/issue_label_bot.yaml) file to use the popular Github bot. [Activate it or check its documentation](https://github.com/marketplace/issue-label-bot).
1. A [CONTRIBUTING](/.github/CONTRIBUTING.md) explaining how to contribute to the project. [Learn more with the Github guide](https://docs.github.com/en/github/building-a-strong-community/setting-guidelines-for-repository-contributors).
@@ -116,7 +117,7 @@ Files that will get removed after the execution of `SETUP_TEMPLATE.sh` are not s
* After **[generating your new repo with this template](https://github.com/Josee9988/project-template/generate)**, make sure to, right after you clone it, run the script `SETUP_TEMPLATE.sh`.
-* Then you will be presented with all the files modified with your project details and information. It is very important to **manually review every file** to check if it fits your requirements and perform any necessary changes to customize the project as you want.
+* Then you will be presented with all the files modified with your project details and information. It is very important to **manually review every file** to check if it fits your requirements and performs any necessary changes to customize the project as you want.
* If you are using **Windows** and you don't know how to execute the `SETUP_TEMPLATE.sh` script:
1. Install **[git for Windows](https://git-scm.com/download/win)**.
@@ -139,12 +140,12 @@ A couple of screenshots to delight you before you use this template.
-* The README template.
+* The README template. (badges and texts will be replaced with your project details)
-
+
-* The CHANGELOG template.
+* The CHANGELOG template. (project name and project type will be replaced with yours)
From b9e10ae171317d8fd0b48c102f6426f1565483cf Mon Sep 17 00:00:00 2001
From: Josee9988
Date: Fri, 2 Apr 2021 09:12:31 +0200
Subject: [PATCH 066/152] "user and project name are selected automatically"
---
CHANGELOG.md | 6 ++++++
SETUP_TEMPLATE.sh | 19 ++++++++++++++++---
2 files changed, 22 insertions(+), 3 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 23e5252..7a7353b 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -7,6 +7,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
---
+## [**1.1.1**] - 2021-04-02
+
+### Added
+
+* Username and project name are automatically selected (user can manually force change them using bash parameters)
+
## [**1.1.0**] - 2021-03-31
### Added
diff --git a/SETUP_TEMPLATE.sh b/SETUP_TEMPLATE.sh
index bc26374..d4eb8d0 100644
--- a/SETUP_TEMPLATE.sh
+++ b/SETUP_TEMPLATE.sh
@@ -53,10 +53,23 @@ else
source $FILE_FUNCTION_HELPERS || exit # obtain some global functions and variables, if the file isn't found exit
fi
-# prompt for the username, mail and name of the project
-read -p "Enter your $(echo -e "$BBLUE""Github username""$NC") (without '@'): " NEW_USERNAME
+# READ GITHUB USERNAME AND GITHUB PROJECT NAME
+NAME_AND_PROJECT_UNPARSED=$(git ls-remote --get-url)
+
+if [ -z "$1" ]; then # if the username has been manually specified
+ NEW_USERNAME=$(echo "$NAME_AND_PROJECT_UNPARSED" | cut -d':' -f 2 | cut -d'/' -f 1)
+else
+ NEW_USERNAME=$1
+fi
+
+if [ -z "$2" ]; then # if the project name has been manually specified
+ PROJECT_NAME=$(echo "$NAME_AND_PROJECT_UNPARSED" | cut -d'/' -f 2 | cut -d'.' -f 1)
+else
+ PROJECT_NAME=$2
+fi
+
+# prompt for the, mail and type of the project
read -p "Enter your $(echo -e "$BBLUE""email""$NC"): " NEW_EMAIL
-read -p "Enter the name of the $(echo -e "$BBLUE""Github's project""$NC"): " PROJECT_NAME
read -p "Enter $(echo -e "$BBLUE""what your project is""$NC") (program/extension/API/web/CLI tool/backend/frontend/scrapper/automation tool/etc): " PROJECT_TYPE
# confirm that the data is correct
From 55861c38639048fa2b54d7135e204d49a3939589 Mon Sep 17 00:00:00 2001
From: Josee9988
Date: Fri, 2 Apr 2021 09:22:45 +0200
Subject: [PATCH 067/152] "added information in the script about the arguments"
---
README.md | 4 ++--
SETUP_TEMPLATE.sh | 7 ++++++-
2 files changed, 8 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index c78554c..9315759 100644
--- a/README.md
+++ b/README.md
@@ -38,13 +38,13 @@ for more information or guidance, follow the [Github guide](https://docs.github.
3. **Execute** the `SETUP_TEMPLATE.sh` shell script to **customize** the files with your data.
```bash
- bash SETUP_TEMPLATE.sh # execute the setup script.
+ bash SETUP_TEMPLATE.sh
```
Or you can also do it like this:
```bash
- chmod u+x SETUP_TEMPLATE.sh && ./SETUP_TEMPLATE-sh # another way of executing it
+ chmod u+x SETUP_TEMPLATE.sh && ./SETUP_TEMPLATE.sh
```
Additionally, watch *[this video](https://asciinema.org/a/400202)* to see **how to execute the script**.
diff --git a/SETUP_TEMPLATE.sh b/SETUP_TEMPLATE.sh
index d4eb8d0..6a59f06 100644
--- a/SETUP_TEMPLATE.sh
+++ b/SETUP_TEMPLATE.sh
@@ -110,7 +110,12 @@ y | Y)
# self remove this script
rm -- "$0"
;;
-n | N) echo "Then try it again!" ;;
+n | N)
+ echo -e "\nIf your username or project name are NOT right (the autoselection wasn't successful), execute the script and give as a first argument your username and as a second argument your project name."
+ echo "As an example:"
+ echo -e "${UPurple}$0 MyCorrectUsername MyCorrectProjectName${NC}"
+ echo "Being the profile as: $0 "
+ ;;
*) echo -e "${RED}Invalid option${NC}" ;;
esac
From 78225adc8961a4bb3ddbd3097206a2930443661c Mon Sep 17 00:00:00 2001
From: Josee9988
Date: Fri, 2 Apr 2021 09:38:45 +0200
Subject: [PATCH 068/152] "updated documentation"
---
CHANGELOG.md | 6 +++++-
README.md | 8 +++++---
SETUP_TEMPLATE.sh | 2 +-
3 files changed, 11 insertions(+), 5 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 7a7353b..d71aada 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -11,7 +11,11 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
### Added
-* Username and project name are automatically selected (user can manually force change them using bash parameters)
+* Username and project name are automatically selected (user can manually force change them using bash parameters [Username] [Project-Name])
+
+### Changed
+
+* Asciinema video
## [**1.1.0**] - 2021-03-31
diff --git a/README.md b/README.md
index 9315759..71a2dac 100644
--- a/README.md
+++ b/README.md
@@ -38,16 +38,18 @@ for more information or guidance, follow the [Github guide](https://docs.github.
3. **Execute** the `SETUP_TEMPLATE.sh` shell script to **customize** the files with your data.
```bash
- bash SETUP_TEMPLATE.sh
+ bash SETUP_TEMPLATE.sh # additional parameters [Username] [Project-Name]
```
Or you can also do it like this:
```bash
- chmod u+x SETUP_TEMPLATE.sh && ./SETUP_TEMPLATE.sh
+ chmod u+x SETUP_TEMPLATE.sh && ./SETUP_TEMPLATE.sh # additional parameters [Username] [Project-Name]
```
- Additionally, watch *[this video](https://asciinema.org/a/400202)* to see **how to execute the script**.
+ Additionally, watch *[this video](https://asciinema.org/a/404568)* to see **how to execute the script**.
+
+ If the automatic detection of the username and project name are NOT right, please post an issue, and you can **manually correct** them like: `bash SETUP_TEMPLATE.sh RightUsername RightProjectName` being `$1` the new username and `$2` the new project name.
4. **Review** every single file and **customize** it as you like.
5. Build your project. π
diff --git a/SETUP_TEMPLATE.sh b/SETUP_TEMPLATE.sh
index 6a59f06..760f1ed 100644
--- a/SETUP_TEMPLATE.sh
+++ b/SETUP_TEMPLATE.sh
@@ -114,7 +114,7 @@ n | N)
echo -e "\nIf your username or project name are NOT right (the autoselection wasn't successful), execute the script and give as a first argument your username and as a second argument your project name."
echo "As an example:"
echo -e "${UPurple}$0 MyCorrectUsername MyCorrectProjectName${NC}"
- echo "Being the profile as: $0 "
+ echo "Being the profile as: $0 [Username] [Project-Name]"
;;
*) echo -e "${RED}Invalid option${NC}" ;;
esac
From ff31af93e5ae1eb09c458513f9882c10387f7efb Mon Sep 17 00:00:00 2001
From: Josee9988
Date: Fri, 2 Apr 2021 09:46:46 +0200
Subject: [PATCH 069/152] "added dev.to post"
---
README.md | 1 +
1 file changed, 1 insertion(+)
diff --git a/README.md b/README.md
index 71a2dac..0d62516 100644
--- a/README.md
+++ b/README.md
@@ -166,6 +166,7 @@ A couple of screenshots to delight you before you use this template.
For the right maintenance of the CHANGELOG.md, we recommend this [VSCode extension](https://github.com/Josee9988/Changelog-and-Markdown-snippets)
and the read and understanding of the [keep a changelog guide](https://keepachangelog.com/en/1.0.0/).
+Read and comment about it in this [dev.to post](https://dev.to/josee9988/the-ultimate-github-project-template-1264).
---
From e8939b44484687796f96c893580ab0b52c6bb42c Mon Sep 17 00:00:00 2001
From: Josee9988
Date: Thu, 8 Apr 2021 08:43:44 +0200
Subject: [PATCH 070/152] "bug issue template will have the preceding '[BUG]'
title"
---
.github/ISSUE_TEMPLATE/1-bug-report.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/.github/ISSUE_TEMPLATE/1-bug-report.md b/.github/ISSUE_TEMPLATE/1-bug-report.md
index 13ca699..4fa6a65 100644
--- a/.github/ISSUE_TEMPLATE/1-bug-report.md
+++ b/.github/ISSUE_TEMPLATE/1-bug-report.md
@@ -1,7 +1,7 @@
---
name: "π Bug Report"
about: "Report an issue to help the project improve."
-title: ""
+title: "[Bug] "
labels: bug
assignees: Josee9988
From 12979b19023c3916eaf79e0795087efc40221c1f Mon Sep 17 00:00:00 2001
From: Josee9988
Date: Thu, 8 Apr 2021 08:57:55 +0200
Subject: [PATCH 071/152] "improved and added multiple more sections to the
user readme.md"
---
CHANGELOG.md | 8 +++++
bin/FUNCTION_HELPERS.sh | 67 ++++++++++++++++++++++++++++++-----------
2 files changed, 57 insertions(+), 18 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index d71aada..ab4d709 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -7,6 +7,14 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
---
+## [**1.2.0**] - 2021-04-07
+
+### Added
+
+* Bug report issue templates have the preceding "[BUG]" title.
+* Multiple readme template headings (About the project, project tree, screenshots, donators).
+* Improved README.md template by fixing some minor problems.
+
## [**1.1.1**] - 2021-04-02
### Added
diff --git a/bin/FUNCTION_HELPERS.sh b/bin/FUNCTION_HELPERS.sh
index 08e657f..3f18b5f 100644
--- a/bin/FUNCTION_HELPERS.sh
+++ b/bin/FUNCTION_HELPERS.sh
@@ -3,53 +3,84 @@
# SCRIPT WITH EXPORTED FUNCTIONS AND VARIABLES
writeREADME() {
- bash -c "NEW_USERNAME='NEW_USERNAME' PROJECT_NAME='PROJECT_NAME' PROJECT_TYPE='PROJECT_TYPE'; cat << EOF > README.md
-
+ bash -c "NEW_USERNAME='NEW_USERNAME' PROJECT_NAME='PROJECT_NAME' PROJECT_TYPE='PROJECT_TYPE'; cat << EOF > README.md
+
# π₯ **$NEW_USERNAME/$PROJECT_NAME**
-
+
-
+
---
-# β‘ **Getting started**
+## π€ **About the project**
-*
+*
---
-# π **Usage**
+## β‘ **Installation**
-*
+*
---
-# π **Aditional notes**
+### π **Usage**
-*
+*
---
-# βοΈ **License and Changelog**
+### π² **Project tree**
-See the license in **[LICENSE](LICENSE)** file.
+*
-Watch the changes in the **[CHANGELOG.md](CHANGELOG.md)** file.
+---
+
+## π **Additional notes**
+
+*
+
+---
+
+## πΈ **Screenshots**
+
+
+
+---
+
+## π° **Supporters and donators**
+
+We are currently looking for new donators to help and maintain this project! β€οΈ
+
+By donating, you will help the development of this project and, *you will be featured in this $PROJECT_NAME's README.md* so everyone can see your kindness and visit your content β.
+
+
+
+
+
+
+
+---
+
+## βοΈπ **License and Changelog**
+
+See the license in the '**[LICENSE](LICENSE)**' file.
+
+Watch the changes in the '**[CHANGELOG.md](CHANGELOG.md)**' file.
---
-
-This project was generated using *[Josee9988/project-template](https://github.com/Josee9988/project-template)* π
+$PROJECT_NAME was generated from *[Josee9988/project-template](https://github.com/Josee9988/project-template)* π
---
-## π Was the $PROJECT_TYPE helpful? Help us raise these numbers up
+## π Was the $PROJECT_TYPE helpful? Help us raise these numbers up!
[![Github followers](https://img.shields.io/github/followers/$NEW_USERNAME.svg?style=social)](https://github.com/$NEW_USERNAME)
[![Github stars](https://img.shields.io/github/stars/$NEW_USERNAME/$PROJECT_NAME.svg?style=social)](https://github.com/$NEW_USERNAME/$PROJECT_NAME/stargazers)
@@ -64,8 +95,8 @@ EOF"
}
writeCHANGELOG() {
- ACTUAL_DATE=$(date '+%Y-%m-%d')
- bash -c "PROJECT_NAME='PROJECT_NAME' PROJECT_TYPE='PROJECT_TYPE' ACTUAL_DATE='ACTUAL_DATE'; cat << EOF > CHANGELOG.md
+ ACTUAL_DATE=$(date '+%Y-%m-%d')
+ bash -c "PROJECT_NAME='PROJECT_NAME' PROJECT_TYPE='PROJECT_TYPE' ACTUAL_DATE='ACTUAL_DATE'; cat << EOF > CHANGELOG.md
# **Change Log** ππ
From 7f2698f0f8397773a5356a742e9cddfc65075166 Mon Sep 17 00:00:00 2001
From: Josee9988
Date: Thu, 8 Apr 2021 09:02:35 +0200
Subject: [PATCH 072/152] "fixed donator badge"
---
bin/FUNCTION_HELPERS.sh | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/bin/FUNCTION_HELPERS.sh b/bin/FUNCTION_HELPERS.sh
index 3f18b5f..e15d422 100644
--- a/bin/FUNCTION_HELPERS.sh
+++ b/bin/FUNCTION_HELPERS.sh
@@ -3,6 +3,7 @@
# SCRIPT WITH EXPORTED FUNCTIONS AND VARIABLES
writeREADME() {
+ PROJECT_NAME=${PROJECT_NAME/-/ }
bash -c "NEW_USERNAME='NEW_USERNAME' PROJECT_NAME='PROJECT_NAME' PROJECT_TYPE='PROJECT_TYPE'; cat << EOF > README.md
# π₯ **$NEW_USERNAME/$PROJECT_NAME**
@@ -61,7 +62,7 @@ We are currently looking for new donators to help and maintain this project! β€
By donating, you will help the development of this project and, *you will be featured in this $PROJECT_NAME's README.md* so everyone can see your kindness and visit your content β.
-
+
From bfe7d331f4f4891c24c595d740eb9015a918a0e3 Mon Sep 17 00:00:00 2001
From: Josee9988
Date: Thu, 8 Apr 2021 09:05:01 +0200
Subject: [PATCH 073/152] "added name to the github sponsors badge"
---
bin/FUNCTION_HELPERS.sh | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/bin/FUNCTION_HELPERS.sh b/bin/FUNCTION_HELPERS.sh
index e15d422..a58869f 100644
--- a/bin/FUNCTION_HELPERS.sh
+++ b/bin/FUNCTION_HELPERS.sh
@@ -31,15 +31,15 @@ writeREADME() {
---
-### π **Usage**
+## π **Usage**
*
---
-### π² **Project tree**
+## π² **Project tree**
-*
+*
---
@@ -62,7 +62,7 @@ We are currently looking for new donators to help and maintain this project! β€
By donating, you will help the development of this project and, *you will be featured in this $PROJECT_NAME's README.md* so everyone can see your kindness and visit your content β.
-
+
From b370974f99319c2d9853071bf0d7bf7049861338 Mon Sep 17 00:00:00 2001
From: Josee9988
Date: Thu, 8 Apr 2021 09:11:31 +0200
Subject: [PATCH 074/152] "reorganized and reordered both user and repo
readme.md"
---
README.md | 4 +++-
bin/FUNCTION_HELPERS.sh | 23 ++++++++++++++++-------
2 files changed, 19 insertions(+), 8 deletions(-)
diff --git a/README.md b/README.md
index 0d62516..5a16e7b 100644
--- a/README.md
+++ b/README.md
@@ -115,7 +115,7 @@ Files that will get removed after the execution of `SETUP_TEMPLATE.sh` are not s
---
-## π΅οΈ **Extra recommendations**
+## π **Additional notes**
* After **[generating your new repo with this template](https://github.com/Josee9988/project-template/generate)**, make sure to, right after you clone it, run the script `SETUP_TEMPLATE.sh`.
@@ -164,6 +164,8 @@ A couple of screenshots to delight you before you use this template.
---
+## π΅οΈ **Extra recommendations**
+
For the right maintenance of the CHANGELOG.md, we recommend this [VSCode extension](https://github.com/Josee9988/Changelog-and-Markdown-snippets)
and the read and understanding of the [keep a changelog guide](https://keepachangelog.com/en/1.0.0/).
Read and comment about it in this [dev.to post](https://dev.to/josee9988/the-ultimate-github-project-template-1264).
diff --git a/bin/FUNCTION_HELPERS.sh b/bin/FUNCTION_HELPERS.sh
index a58869f..d275ab2 100644
--- a/bin/FUNCTION_HELPERS.sh
+++ b/bin/FUNCTION_HELPERS.sh
@@ -69,28 +69,37 @@ By donating, you will help the development of this project and, *you will be fea
---
-## βοΈπ **License and Changelog**
-
-See the license in the '**[LICENSE](LICENSE)**' file.
-
-Watch the changes in the '**[CHANGELOG.md](CHANGELOG.md)**' file.
+$PROJECT_NAME was generated from *[Josee9988/project-template](https://github.com/Josee9988/project-template)* π
---
-$PROJECT_NAME was generated from *[Josee9988/project-template](https://github.com/Josee9988/project-template)* π
+π΅οΈ Extra recommendations
+
+*
---
-## π Was the $PROJECT_TYPE helpful? Help us raise these numbers up!
+## π Was the $PROJECT_TYPE helpful? Help us raise these numbers up
[![Github followers](https://img.shields.io/github/followers/$NEW_USERNAME.svg?style=social)](https://github.com/$NEW_USERNAME)
[![Github stars](https://img.shields.io/github/stars/$NEW_USERNAME/$PROJECT_NAME.svg?style=social)](https://github.com/$NEW_USERNAME/$PROJECT_NAME/stargazers)
[![Github watchers](https://img.shields.io/github/watchers/$NEW_USERNAME/$PROJECT_NAME.svg?style=social)](https://github.com/$NEW_USERNAME/$PROJECT_NAME/watchers)
[![Github forks](https://img.shields.io/github/forks/$NEW_USERNAME/$PROJECT_NAME.svg?style=social)](https://github.com/$NEW_USERNAME/$PROJECT_NAME/network/members)
+
[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=github-sponsors&color=red&style=social)](https://github.com/sponsors/$NEW_USERNAME)
Enjoy! π
+---
+
+## βοΈπ **License and Changelog**
+
+See the license in the '**[LICENSE](LICENSE)**' file.
+
+Watch the changes in the '**[CHANGELOG.md](CHANGELOG.md)**' file.
+
+---
+
_Made with a lot of β€οΈβ€οΈ by **[@$NEW_USERNAME](https://github.com/$NEW_USERNAME)**_
EOF"
}
From 63b3cdc7caf836e95993314d10b64f151d96311e Mon Sep 17 00:00:00 2001
From: Josee9988
Date: Thu, 8 Apr 2021 09:14:39 +0200
Subject: [PATCH 075/152] "for the github sponsor badge the project name will
not have any '-'"
---
bin/FUNCTION_HELPERS.sh | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/bin/FUNCTION_HELPERS.sh b/bin/FUNCTION_HELPERS.sh
index d275ab2..cfd665f 100644
--- a/bin/FUNCTION_HELPERS.sh
+++ b/bin/FUNCTION_HELPERS.sh
@@ -3,7 +3,7 @@
# SCRIPT WITH EXPORTED FUNCTIONS AND VARIABLES
writeREADME() {
- PROJECT_NAME=${PROJECT_NAME/-/ }
+ PROJECT_NAME_PARSED=${PROJECT_NAME/-/ }
bash -c "NEW_USERNAME='NEW_USERNAME' PROJECT_NAME='PROJECT_NAME' PROJECT_TYPE='PROJECT_TYPE'; cat << EOF > README.md
# π₯ **$NEW_USERNAME/$PROJECT_NAME**
@@ -62,7 +62,7 @@ We are currently looking for new donators to help and maintain this project! β€
By donating, you will help the development of this project and, *you will be featured in this $PROJECT_NAME's README.md* so everyone can see your kindness and visit your content β.
-
+
From b5e107197cdf324ef2423c9c7dfdd4dce4997e85 Mon Sep 17 00:00:00 2001
From: Josee9988
Date: Thu, 8 Apr 2021 09:34:13 +0200
Subject: [PATCH 076/152] "updated project screenshots to fit the new readme
changs"
---
README.md | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 5a16e7b..b99b2a2 100644
--- a/README.md
+++ b/README.md
@@ -144,7 +144,9 @@ A couple of screenshots to delight you before you use this template.
* The README template. (badges and texts will be replaced with your project details)
-
+
+
+
* The CHANGELOG template. (project name and project type will be replaced with yours)
From a154759f5e56617a8844ba8d5fdfe7172c40d706 Mon Sep 17 00:00:00 2001
From: Josee9988
Date: Thu, 8 Apr 2021 09:37:26 +0200
Subject: [PATCH 077/152] "added video to see the whole readme.md video"
---
README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/README.md b/README.md
index b99b2a2..0576af7 100644
--- a/README.md
+++ b/README.md
@@ -146,7 +146,7 @@ A couple of screenshots to delight you before you use this template.
-
+ Or watch a [this video](https://i.imgur.com/tKs4fFc.mp4) to see the whole README template.
* The CHANGELOG template. (project name and project type will be replaced with yours)
From d44ef97138c5db8a38a45c80303d73d127fffb79 Mon Sep 17 00:00:00 2001
From: Josee9988
Date: Thu, 8 Apr 2021 09:39:20 +0200
Subject: [PATCH 078/152] "video now has more quality"
---
README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 0576af7..40683e2 100644
--- a/README.md
+++ b/README.md
@@ -146,7 +146,7 @@ A couple of screenshots to delight you before you use this template.
- Or watch a [this video](https://i.imgur.com/tKs4fFc.mp4) to see the whole README template.
+ Or watch a [this video](https://gifs.com/gif/josee9988-s-readme-md-MwO5E3) to see the whole README template.
* The CHANGELOG template. (project name and project type will be replaced with yours)
From 66016121271ba524c92a9e9f2cb9db2f3a46e5ed Mon Sep 17 00:00:00 2001
From: Josee9988
Date: Wed, 14 Apr 2021 15:41:06 +0200
Subject: [PATCH 079/152] "added codeowners file"
---
.github/CODEOWNERS | 6 ++++++
1 file changed, 6 insertions(+)
create mode 100644 .github/CODEOWNERS
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
new file mode 100644
index 0000000..4cb66d4
--- /dev/null
+++ b/.github/CODEOWNERS
@@ -0,0 +1,6 @@
+# These owners will be the default owners for everything in
+# the repo. Unless a later match takes precedence,
+# @Josee9988 will be requested for
+# review when someone opens a pull request.
+# if you want to add more owners just write it after @Josee9988
+* @Josee9988
From e5f5abd600a2fcdea7f5f53d57ca074e744ecb47 Mon Sep 17 00:00:00 2001
From: Josee9988
Date: Thu, 15 Apr 2021 08:27:25 +0200
Subject: [PATCH 080/152] "1.3.0 added codeowners file"
---
CHANGELOG.md | 10 ++++++++++
README.md | 38 +++++++++++++++++++++++++-------------
2 files changed, 35 insertions(+), 13 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index ab4d709..e24548b 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -7,6 +7,16 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
---
+## [**1.3.0**] - 2021-04-14
+
+### Added
+
+* CODEOWNERS file inside the .github folder.
+
+### Fixed
+
+* Some README.md markdownlint bugs.
+
## [**1.2.0**] - 2021-04-07
### Added
diff --git a/README.md b/README.md
index 40683e2..d6cf3b6 100644
--- a/README.md
+++ b/README.md
@@ -32,9 +32,9 @@ clone your new repository and execute the `SETUP_TEMPLATE.sh` shell script to pe
## β‘ **Installation**
-1. To create a new repository from this template [generate your new repository from this template](https://github.com/Josee9988/project-template/generate)
+1. To create a new repository from this template **[generate your new repository from this template](https://github.com/Josee9988/project-template/generate)**
for more information or guidance, follow the [Github guide](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template).
-2. Clone your repo and `cd` into it.
+2. Clone your new repository **[generated from this template](https://github.com/Josee9988/project-template/generate)** and `cd` into it.
3. **Execute** the `SETUP_TEMPLATE.sh` shell script to **customize** the files with your data.
```bash
@@ -69,9 +69,10 @@ The script will replace Jose's username and email (the author) with yours from a
1. A [CONTRIBUTING](/.github/CONTRIBUTING.md) explaining how to contribute to the project. [Learn more with the Github guide](https://docs.github.com/en/github/building-a-strong-community/setting-guidelines-for-repository-contributors).
1. A [SUPPORT](/.github/SUPPORT.md) explaining how to support the project. [Learn more with the Github guide](https://docs.github.com/en/github/building-a-strong-community/adding-support-resources-to-your-project).
1. A [SECURITY](/.github/SECURITY.md) with a guide on how to post a security issue. [Learn more with the Github guide](https://docs.github.com/es/github/managing-security-vulnerabilities/adding-a-security-policy-to-your-repository).
- 1. A [CODE_OF_CONDUCT](/.github/CODE_OF_CONDUCT.md) with a basic code of conduct. [Learn more with the Github guide](https://docs.github.com/en/github/building-a-strong-community/adding-a-code-of-conduct-to-your-project).
- 1. A [PULL_REQUEST_TEMPLATE](/.github/pull_request_template.md) with a template for your pull request that closes issues with keywords. [Learn more with the Github guide](https://docs.github.com/es/github/building-a-strong-community/creating-a-pull-request-template-for-your-repository).
- 1. Multiple [issues templates](/.github/ISSUE_TEMPLATE). [Learn more with the Github guide](https://docs.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository).
+1. A [CODEOWNERS](/.github/CODEOWNERS) with the new user as the main owner. [Learn more with the Github guide](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners).
+1. A [CODE_OF_CONDUCT](/.github/CODE_OF_CONDUCT.md) with a basic code of conduct. [Learn more with the Github guide](https://docs.github.com/en/github/building-a-strong-community/adding-a-code-of-conduct-to-your-project).
+1. A [PULL_REQUEST_TEMPLATE](/.github/pull_request_template.md) with a template for your pull request that closes issues with keywords. [Learn more with the Github guide](https://docs.github.com/es/github/building-a-strong-community/creating-a-pull-request-template-for-your-repository).
+1. Multiple [issues templates](/.github/ISSUE_TEMPLATE). [Learn more with the Github guide](https://docs.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository).
1. A [config.yml](/.github/ISSUE_TEMPLATE/config.yml) with the config and information about the issue templates.
1. A [Blank issue template](/.github/ISSUE_TEMPLATE) with the super basic stuff, all the issues should contain.
1. A [Bug issue template](/.github/ISSUE_TEMPLATE/1-bug-report.md).
@@ -91,6 +92,7 @@ Files that will get removed after the execution of `SETUP_TEMPLATE.sh` are not s
.
βββ CHANGELOG.md
βββ .github
+βΒ Β βββ CODEOWNERS
βΒ Β βββ CODE_OF_CONDUCT.md
βΒ Β βββ CONTRIBUTING.md
βΒ Β βββ FUNDING.yml
@@ -110,7 +112,7 @@ Files that will get removed after the execution of `SETUP_TEMPLATE.sh` are not s
βββ .gitignore
βββ README.md
-2 directories, 20 files
+2 directories, 21 files
```
---
@@ -132,34 +134,44 @@ Files that will get removed after the execution of `SETUP_TEMPLATE.sh` are not s
A couple of screenshots to delight you before you use this template.
-* All the issue templates.
+### πΊ All the issue templates
+
-* An issue template opened.
+### π» An issue template opened
+
-* The README template. (badges and texts will be replaced with your project details)
+### π The README template
+
+(badges and texts will be replaced with your project details)
+
- Or watch a [this video](https://gifs.com/gif/josee9988-s-readme-md-MwO5E3) to see the whole README template.
+ Or watch [this video](https://gifs.com/gif/josee9988-s-readme-md-MwO5E3) to see the whole README template.
-* The CHANGELOG template. (project name and project type will be replaced with yours)
+### π The CHANGELOG template
+
+(project name and project type will be replaced with yours)
+
-* Security policy
+### π‘οΈ Security policy
+
-* Community profile at 100%
+### πΌ Community profile at 100%
+
From 878a9230c75eb994b489259b4e9c93c0b7f69c3a Mon Sep 17 00:00:00 2001
From: Josee9988
Date: Fri, 16 Apr 2021 19:17:52 +0200
Subject: [PATCH 081/152] "added used bots section in the readme.md"
---
CHANGELOG.md | 7 +++++++
README.md | 5 +++++
SETUP_TEMPLATE.sh | 3 +++
3 files changed, 15 insertions(+)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index e24548b..077046c 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -7,6 +7,13 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
---
+## [Unreleased]
+
+### Added
+
+* Readme section with the recommended/used bots that the users should install.
+* Some informational comments in the script referencing the project's documentation.
+
## [**1.3.0**] - 2021-04-14
### Added
diff --git a/README.md b/README.md
index d6cf3b6..2931cec 100644
--- a/README.md
+++ b/README.md
@@ -128,6 +128,10 @@ Files that will get removed after the execution of `SETUP_TEMPLATE.sh` are not s
2. Right-click on the git repository folder and click "*git bash here*".
3. Then just perform *`bash SETUP_TEMPLATE.sh`* **or** *`chmod u+x SETUP_TEMPLATE.sh && ./SETUP_TEMPLATE.sh`*.
+### π€ **Used Github bots**
+
+1. The `issue_label_bot.yaml` file depends on the **[issue label bot](https://github.com/marketplace/issue-label-bot)**.
+
---
## πΈ **Screenshots**
@@ -183,6 +187,7 @@ A couple of screenshots to delight you before you use this template.
For the right maintenance of the CHANGELOG.md, we recommend this [VSCode extension](https://github.com/Josee9988/Changelog-and-Markdown-snippets)
and the read and understanding of the [keep a changelog guide](https://keepachangelog.com/en/1.0.0/).
Read and comment about it in this [dev.to post](https://dev.to/josee9988/the-ultimate-github-project-template-1264).
+We also recommend installing all the used bots.
---
diff --git a/SETUP_TEMPLATE.sh b/SETUP_TEMPLATE.sh
index 760f1ed..9cbade8 100644
--- a/SETUP_TEMPLATE.sh
+++ b/SETUP_TEMPLATE.sh
@@ -29,6 +29,7 @@ BBLUE='\033[1;34m'
GREEN='\033[1;32m'
FILE_FUNCTION_HELPERS=bin/FUNCTION_HELPERS.sh
+###### CHECKS BEFORE THE SCRIPT STARTS ######
### Check if the .github directory does exist ###
if [ ! -d ".github/" ]; then
echo -e "${RED}Directory .github/ DOES NOT EXIST.${NC}"
@@ -68,6 +69,8 @@ else
PROJECT_NAME=$2
fi
+###### START OF THE SCRIPT ######
+echo -e "Read carefully all the documentation before you continue executing this script: \t${UPurple}https://github.com/Josee9988/project-template${NC}"
# prompt for the, mail and type of the project
read -p "Enter your $(echo -e "$BBLUE""email""$NC"): " NEW_EMAIL
read -p "Enter $(echo -e "$BBLUE""what your project is""$NC") (program/extension/API/web/CLI tool/backend/frontend/scrapper/automation tool/etc): " PROJECT_TYPE
From 2cf9a4e7b5cc41c81c794c9148d60c84f8c10a64 Mon Sep 17 00:00:00 2001
From: Josee9988
Date: Sat, 17 Apr 2021 09:30:59 +0200
Subject: [PATCH 082/152] "added some labels in the new settings.yml file"
---
.github/settings.yml | 144 +++++++++++++++++++++++++++++++++++++++++++
README.md | 2 +-
2 files changed, 145 insertions(+), 1 deletion(-)
create mode 100644 .github/settings.yml
diff --git a/.github/settings.yml b/.github/settings.yml
new file mode 100644
index 0000000..1430cf8
--- /dev/null
+++ b/.github/settings.yml
@@ -0,0 +1,144 @@
+repository:
+ # See https://developer.github.com/v3/repos/#edit for all available settings.
+
+ # The name of the repository. Changing this will rename the repository
+ #name: repo-name
+
+ # A short description of the repository that will show up on GitHub
+ #description: description of repo
+
+ # A URL with more information about the repository
+ #homepage: https://example.github.io/
+
+ # A comma-separated list of topics to set on the repository
+ #topics: project, template, project-template
+
+ # Either `true` to make the repository private, or `false` to make it public.
+ #private: false
+
+ # Either `true` to enable issues for this repository, `false` to disable them.
+ #has_issues: true
+
+ # Either `true` to enable the wiki for this repository, `false` to disable it.
+ #has_wiki: true
+
+ # Either `true` to enable downloads for this repository, `false` to disable them.
+ #has_downloads: true
+
+ # Updates the default branch for this repository.
+ #default_branch: master
+
+ # Either `true` to allow squash-merging pull requests, or `false` to prevent
+ # squash-merging.
+ #allow_squash_merge: true
+
+ # Either `true` to allow merging pull requests with a merge commit, or `false`
+ # to prevent merging pull requests with merge commits.
+ #allow_merge_commit: true
+
+ # Either `true` to allow rebase-merging pull requests, or `false` to prevent
+ # rebase-merging.
+ #allow_rebase_merge: true
+
+# Labels: define labels for Issues and Pull Requests
+labels:
+ - name: Bug
+ color: CC0000
+ description: π An issue with the project
+ oldname: bug
+
+ - name: Feature
+ color: 486DB8
+ description: π Suggest a new feature for the project
+ oldname: enhancement
+
+ - name: Invalid
+ color: E2E62E
+ description: This issue doesn't seem right
+ oldname: invalid
+
+ - name: Question
+ color: 962EE6
+ description: β This issue is just a question
+ oldname: question
+
+ - name: Extra information needed
+ color: D9840D
+ description: β οΈ This won't be solved until we have more information about the issue
+
+ - name: 3rd party issue
+ color: D90D8B
+ description: π¦ This issue might be caused by a 3rd party script/package/...
+
+ - name: Windows
+ color: 2E65E6
+ Description: Is windows-specific
+
+ - name: Mac
+ color: AEB1C2
+ Description: Is mac-specific
+
+ - name: Linux
+ color: B56838
+ Description: Is linux-specific
+# # Collaborators: give specific users access to this repository.
+# # See https://developer.github.com/v3/repos/collaborators/#add-user-as-a-collaborator for available options
+# collaborators:
+# # - username: bkeepers
+# # permission: push
+# # - username: hubot
+# # permission: pull
+
+# # Note: `permission` is only valid on organization-owned repositories.
+# # The permission to grant the collaborator. Can be one of:
+# # * `pull` - can pull, but not push to or administer this repository.
+# # * `push` - can pull and push, but not administer this repository.
+# # * `admin` - can pull, push and administer this repository.
+# # * `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions.
+# # * `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access.
+
+# # See https://developer.github.com/v3/teams/#add-or-update-team-repository for available options
+# teams:
+# - name: core
+# # The permission to grant the team. Can be one of:
+# # * `pull` - can pull, but not push to or administer this repository.
+# # * `push` - can pull and push, but not administer this repository.
+# # * `admin` - can pull, push and administer this repository.
+# # * `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions.
+# # * `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access.
+# permission: admin
+# - name: docs
+# permission: push
+
+# branches:
+# - name: master
+# # https://developer.github.com/v3/repos/branches/#update-branch-protection
+# # Branch Protection settings. Set to null to disable
+# protection:
+# # Required. Require at least one approving review on a pull request, before merging. Set to null to disable.
+# required_pull_request_reviews:
+# # The number of approvals required. (1-6)
+# required_approving_review_count: 1
+# # Dismiss approved reviews automatically when a new commit is pushed.
+# dismiss_stale_reviews: true
+# # Blocks merge until code owners have reviewed.
+# require_code_owner_reviews: true
+# # Specify which users and teams can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.
+# dismissal_restrictions:
+# users: []
+# teams: []
+# # Required. Require status checks to pass before merging. Set to null to disable
+# required_status_checks:
+# # Required. Require branches to be up to date before merging.
+# strict: true
+# # Required. The list of status checks to require in order to merge into this branch
+# contexts: []
+# # Required. Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.
+# enforce_admins: true
+# # Prevent merge commits from being pushed to matching branches
+# required_linear_history: true
+# # Required. Restrict who can push to this branch. Team and user restrictions are only available for organization-owned repositories. Set to null to disable.
+# restrictions:
+# apps: []
+# users: []
+# teams: []
diff --git a/README.md b/README.md
index 2931cec..d6d6722 100644
--- a/README.md
+++ b/README.md
@@ -187,7 +187,7 @@ A couple of screenshots to delight you before you use this template.
For the right maintenance of the CHANGELOG.md, we recommend this [VSCode extension](https://github.com/Josee9988/Changelog-and-Markdown-snippets)
and the read and understanding of the [keep a changelog guide](https://keepachangelog.com/en/1.0.0/).
Read and comment about it in this [dev.to post](https://dev.to/josee9988/the-ultimate-github-project-template-1264).
-We also recommend installing all the used bots.
+We also recommend installing all the [used bots](https://github.com/Josee9988/project-template#-used-github-bots).
---
From 8feb39761e3eb385e808583f77e3fc40fef58a07 Mon Sep 17 00:00:00 2001
From: Josee9988
Date: Sat, 17 Apr 2021 09:43:52 +0200
Subject: [PATCH 083/152] "updated some new labels"
---
.github/issue_label_bot.yaml | 6 +++---
.github/settings.yml | 30 +++++++++---------------------
2 files changed, 12 insertions(+), 24 deletions(-)
diff --git a/.github/issue_label_bot.yaml b/.github/issue_label_bot.yaml
index b642226..c5b27aa 100644
--- a/.github/issue_label_bot.yaml
+++ b/.github/issue_label_bot.yaml
@@ -1,4 +1,4 @@
label-alias:
- bug: 'bug'
- feature_request: 'enhancement'
- question: 'question'
+ bug: 'Bug'
+ feature_request: 'Feature'
+ question: 'Question'
diff --git a/.github/settings.yml b/.github/settings.yml
index 1430cf8..ef245e7 100644
--- a/.github/settings.yml
+++ b/.github/settings.yml
@@ -44,43 +44,31 @@ repository:
labels:
- name: Bug
color: CC0000
- description: π An issue with the project
- oldname: bug
-
+ description: 'π An issue with the project'
- name: Feature
color: 486DB8
- description: π Suggest a new feature for the project
- oldname: enhancement
-
+ description: 'π Suggest a new feature for the project'
- name: Invalid
color: E2E62E
- description: This issue doesn't seem right
- oldname: invalid
-
+ description: "β οΈ This issue doesn't seem right"
- name: Question
color: 962EE6
- description: β This issue is just a question
- oldname: question
-
+ description: 'β This issue is just a question'
- name: Extra information needed
color: D9840D
- description: β οΈ This won't be solved until we have more information about the issue
-
+ description: "This won't be solved until we have more information about the issue"
- name: 3rd party issue
color: D90D8B
- description: π¦ This issue might be caused by a 3rd party script/package/...
-
+ description: 'π¦ This issue might be caused by a 3rd party script/package/...'
- name: Windows
color: 2E65E6
- Description: Is windows-specific
-
+ Description: 'Is windows-specific'
- name: Mac
color: AEB1C2
- Description: Is mac-specific
-
+ Description: 'Is mac-specific'
- name: Linux
color: B56838
- Description: Is linux-specific
+ Description: 'Is linux-specific'
# # Collaborators: give specific users access to this repository.
# # See https://developer.github.com/v3/repos/collaborators/#add-user-as-a-collaborator for available options
# collaborators:
From 5f23a5b430876a4218ce7a2750f8aff3bb1cd7c4 Mon Sep 17 00:00:00 2001
From: Josee9988
Date: Sun, 18 Apr 2021 09:28:58 +0200
Subject: [PATCH 084/152] "quoted all the labels to prevent scaping"
---
.github/settings.yml | 40 ++++++++++++++++++++++------------------
1 file changed, 22 insertions(+), 18 deletions(-)
diff --git a/.github/settings.yml b/.github/settings.yml
index ef245e7..04bd56e 100644
--- a/.github/settings.yml
+++ b/.github/settings.yml
@@ -42,32 +42,36 @@ repository:
# Labels: define labels for Issues and Pull Requests
labels:
- - name: Bug
- color: CC0000
+ - name: 'bug'
+ color: 'CC0000'
description: 'π An issue with the project'
- - name: Feature
- color: 486DB8
+ oldname: 'bug'
+ - name: 'Feature'
+ color: '486DB8'
description: 'π Suggest a new feature for the project'
- - name: Invalid
- color: E2E62E
+ oldname: 'enhancement'
+ - name: 'Invalid'
+ color: 'E2E62E'
description: "β οΈ This issue doesn't seem right"
- - name: Question
- color: 962EE6
+ oldname: 'invalid'
+ - name: 'Question'
+ color: '962EE6'
description: 'β This issue is just a question'
- - name: Extra information needed
- color: D9840D
+ oldname: 'question'
+ - name: 'Extra information needed'
+ color: 'D9840D'
description: "This won't be solved until we have more information about the issue"
- - name: 3rd party issue
- color: D90D8B
+ - name: '3rd party issue'
+ color: 'D90D8B'
description: 'π¦ This issue might be caused by a 3rd party script/package/...'
- - name: Windows
- color: 2E65E6
+ - name: 'Windows'
+ color: '2E65E6'
Description: 'Is windows-specific'
- - name: Mac
- color: AEB1C2
+ - name: 'Mac'
+ color: 'AEB1C2'
Description: 'Is mac-specific'
- - name: Linux
- color: B56838
+ - name: 'Linux'
+ color: 'B56838'
Description: 'Is linux-specific'
# # Collaborators: give specific users access to this repository.
# # See https://developer.github.com/v3/repos/collaborators/#add-user-as-a-collaborator for available options
From 2f108a8a7e3fc4f91deb66063ad768d91a3f44a2 Mon Sep 17 00:00:00 2001
From: Josee9988
Date: Sun, 18 Apr 2021 09:29:10 +0200
Subject: [PATCH 085/152] "all issues are now appearing"
---
.github/settings.yml | 93 +++++++++++++++++++++++++++++++-------------
1 file changed, 67 insertions(+), 26 deletions(-)
diff --git a/.github/settings.yml b/.github/settings.yml
index 04bd56e..6f5f72d 100644
--- a/.github/settings.yml
+++ b/.github/settings.yml
@@ -41,38 +41,79 @@ repository:
#allow_rebase_merge: true
# Labels: define labels for Issues and Pull Requests
+
labels:
- - name: 'bug'
- color: 'CC0000'
- description: 'π An issue with the project'
- oldname: 'bug'
- - name: 'Feature'
- color: '486DB8'
- description: 'π Suggest a new feature for the project'
- oldname: 'enhancement'
+ - name: 'Type: Bug'
+ color: CC0000
+ description: Something isn't working as expected.
+
+ - name: 'Type: Feature'
+ color: 486DB8
+ description: Suggest an improvement for an existing feature.
+
+ - name: 'Type: Enhancement'
+ color: 486DB8
+ description: Suggest a new feature.
+
+ - name: 'Type: Question'
+ color: 312DEB
+ description: Request for information.
+
+ - name: 'Status: Awaiting Review'
+ color: 24d15d
+ description: Ready for review.
+
+ - name: 'Status: Waiting'
+ color: EBCB2D
+ description: Waiting on something else to be ready.
+
+ - name: 'Status: Stale'
+ color: C8D9E6
+ description: Has had no activity for some time.
+
+ - name: 'Duplicate'
+ color: EB862D
+ description: Duplicate of another task.
+
- name: 'Invalid'
- color: 'E2E62E'
- description: "β οΈ This issue doesn't seem right"
- oldname: 'invalid'
- - name: 'Question'
- color: '962EE6'
- description: 'β This issue is just a question'
- oldname: 'question'
- - name: 'Extra information needed'
- color: 'D9840D'
- description: "This won't be solved until we have more information about the issue"
+ color: EB862D
+ description: This issue doesn't seem right.
+
+ - name: 'Priority: High'
+ color: cf1d8d
+ description: Task is considered higher-priority.
+
+ - name: 'Priority: Low'
+ color: 992389
+ description: Task is considered lower-priority.
+
+ - name: 'WIP'
+ color: f0cc1d
+ description: Currently being worked on.
+
+ - name: 'Documentation'
+ color: 2fbceb
+ description: An issue with the documentation.
+
+ - name: "Won't Fix"
+ color: C8D9E6
+ description: Reported issue is working as intended.
+
- name: '3rd party issue'
- color: 'D90D8B'
- description: 'π¦ This issue might be caused by a 3rd party script/package/...'
+ color: D90D8B
+ description: This issue might be caused by a 3rd party script/package/...
+
- name: 'Windows'
- color: '2E65E6'
- Description: 'Is windows-specific'
+ color: 2E65E6
+ Description: Is windows-specific
+
- name: 'Mac'
- color: 'AEB1C2'
- Description: 'Is mac-specific'
+ color: AEB1C2
+ Description: Is mac-specific
+
- name: 'Linux'
- color: 'B56838'
- Description: 'Is linux-specific'
+ color: B56838
+ Description: Is linux-specific
# # Collaborators: give specific users access to this repository.
# # See https://developer.github.com/v3/repos/collaborators/#add-user-as-a-collaborator for available options
# collaborators:
From 297452e865d9f760266c06a1b37eb369a08365f1 Mon Sep 17 00:00:00 2001
From: Josee9988
Date: Sun, 18 Apr 2021 09:34:22 +0200
Subject: [PATCH 086/152] "updated colors"
---
.github/settings.yml | 16 ++++++++--------
1 file changed, 8 insertions(+), 8 deletions(-)
diff --git a/.github/settings.yml b/.github/settings.yml
index 6f5f72d..15bd4d2 100644
--- a/.github/settings.yml
+++ b/.github/settings.yml
@@ -48,15 +48,15 @@ labels:
description: Something isn't working as expected.
- name: 'Type: Feature'
- color: 486DB8
+ color: 6694f2
description: Suggest an improvement for an existing feature.
- name: 'Type: Enhancement'
- color: 486DB8
+ color: 6694f2
description: Suggest a new feature.
- name: 'Type: Question'
- color: 312DEB
+ color: 9309ab
description: Request for information.
- name: 'Status: Awaiting Review'
@@ -64,7 +64,7 @@ labels:
description: Ready for review.
- name: 'Status: Waiting'
- color: EBCB2D
+ color: 38C968
description: Waiting on something else to be ready.
- name: 'Status: Stale'
@@ -76,15 +76,15 @@ labels:
description: Duplicate of another task.
- name: 'Invalid'
- color: EB862D
+ color: faef50
description: This issue doesn't seem right.
- name: 'Priority: High'
- color: cf1d8d
+ color: ff0aa4
description: Task is considered higher-priority.
- name: 'Priority: Low'
- color: 992389
+ color: 871c4b
description: Task is considered lower-priority.
- name: 'WIP'
@@ -112,7 +112,7 @@ labels:
Description: Is mac-specific
- name: 'Linux'
- color: B56838
+ color: E95420
Description: Is linux-specific
# # Collaborators: give specific users access to this repository.
# # See https://developer.github.com/v3/repos/collaborators/#add-user-as-a-collaborator for available options
From 8bb98ec3a5717e3328a5647f731671424e96dd4d Mon Sep 17 00:00:00 2001
From: Josee9988
Date: Sun, 18 Apr 2021 09:35:07 +0200
Subject: [PATCH 087/152] "updated issue label bot to match new settings.yml"
---
.github/issue_label_bot.yaml | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/.github/issue_label_bot.yaml b/.github/issue_label_bot.yaml
index c5b27aa..b83d27f 100644
--- a/.github/issue_label_bot.yaml
+++ b/.github/issue_label_bot.yaml
@@ -1,4 +1,4 @@
label-alias:
- bug: 'Bug'
- feature_request: 'Feature'
- question: 'Question'
+ bug: 'Type: Bug'
+ feature_request: 'Type: Feature'
+ question: 'Type: Question'
From 42f75f2f5fd4d9965d7d4785c8a1a9561cebcdb9 Mon Sep 17 00:00:00 2001
From: Josee9988
Date: Sun, 18 Apr 2021 10:02:58 +0200
Subject: [PATCH 088/152] "updated changelog and fixed and improved some
labels"
---
.github/settings.yml | 12 ++++++------
CHANGELOG.md | 1 +
2 files changed, 7 insertions(+), 6 deletions(-)
diff --git a/.github/settings.yml b/.github/settings.yml
index 15bd4d2..98cc801 100644
--- a/.github/settings.yml
+++ b/.github/settings.yml
@@ -73,17 +73,17 @@ labels:
- name: 'Duplicate'
color: EB862D
- description: Duplicate of another task.
+ description: Duplicate of another issue.
- name: 'Invalid'
color: faef50
description: This issue doesn't seem right.
- - name: 'Priority: High'
+ - name: 'Priority: High +'
color: ff0aa4
description: Task is considered higher-priority.
- - name: 'Priority: Low'
+ - name: 'Priority: Low -'
color: 871c4b
description: Task is considered lower-priority.
@@ -105,15 +105,15 @@ labels:
- name: 'Windows'
color: 2E65E6
- Description: Is windows-specific
+ description: Is Windows-specific
- name: 'Mac'
color: AEB1C2
- Description: Is mac-specific
+ description: Is Mac-specific
- name: 'Linux'
color: E95420
- Description: Is linux-specific
+ description: Is Linux-specific
# # Collaborators: give specific users access to this repository.
# # See https://developer.github.com/v3/repos/collaborators/#add-user-as-a-collaborator for available options
# collaborators:
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 077046c..197a525 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -13,6 +13,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
* Readme section with the recommended/used bots that the users should install.
* Some informational comments in the script referencing the project's documentation.
+* A total of 18 new labels that will be created right when you clone your repo using github probot settings.
## [**1.3.0**] - 2021-04-14
From 00a83ac613d5f0409c9115ce6fef89d90fc10945 Mon Sep 17 00:00:00 2001
From: Josee9988
Date: Mon, 19 Apr 2021 08:08:35 +0200
Subject: [PATCH 089/152] prepared documentation for the new settings bot
feature
---
README.md | 16 ++++++++++++++--
1 file changed, 14 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index d6d6722..8009c17 100644
--- a/README.md
+++ b/README.md
@@ -65,7 +65,8 @@ The script will replace Jose's username and email (the author) with yours from a
1. A README template file with a default template to start documenting your project. (it includes personalized badges and text with your project details)
1. A CHANGELOG template file based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
- 1. An [issue_label_bot.yaml](/.github/issue_label_bot.yaml) file to use the popular Github bot. [Activate it or check its documentation](https://github.com/marketplace/issue-label-bot).
+ 1. An [issue_label_bot.yaml](/.github/issue_label_bot.yaml) file to use the issue adder Github bot. [Activate it or check its documentation](https://github.com/marketplace/issue-label-bot).
+ 1. An [settings.yml](/.github/settings.yml) file to use the popular settings Github bot. [Activate it or check its documentation](https://probot.github.io/apps/settings/).
1. A [CONTRIBUTING](/.github/CONTRIBUTING.md) explaining how to contribute to the project. [Learn more with the Github guide](https://docs.github.com/en/github/building-a-strong-community/setting-guidelines-for-repository-contributors).
1. A [SUPPORT](/.github/SUPPORT.md) explaining how to support the project. [Learn more with the Github guide](https://docs.github.com/en/github/building-a-strong-community/adding-support-resources-to-your-project).
1. A [SECURITY](/.github/SECURITY.md) with a guide on how to post a security issue. [Learn more with the Github guide](https://docs.github.com/es/github/managing-security-vulnerabilities/adding-a-security-policy-to-your-repository).
@@ -92,6 +93,7 @@ Files that will get removed after the execution of `SETUP_TEMPLATE.sh` are not s
.
βββ CHANGELOG.md
βββ .github
+βΒ Β βββ settings.yml
βΒ Β βββ CODEOWNERS
βΒ Β βββ CODE_OF_CONDUCT.md
βΒ Β βββ CONTRIBUTING.md
@@ -112,7 +114,7 @@ Files that will get removed after the execution of `SETUP_TEMPLATE.sh` are not s
βββ .gitignore
βββ README.md
-2 directories, 21 files
+2 directories, 22 files
```
---
@@ -131,6 +133,8 @@ Files that will get removed after the execution of `SETUP_TEMPLATE.sh` are not s
### π€ **Used Github bots**
1. The `issue_label_bot.yaml` file depends on the **[issue label bot](https://github.com/marketplace/issue-label-bot)**.
+2. The `settings.yml` file depends on the **[settings label bot](https://probot.github.io/apps/settings/)**.
+3.
---
@@ -160,6 +164,14 @@ A couple of screenshots to delight you before you use this template.
Or watch [this video](https://gifs.com/gif/josee9988-s-readme-md-MwO5E3) to see the whole README template.