README.md

🔥 Josee9988's Github Project Template

---

🤔 What is this template all about?

• This template can be used as a base layer for any of your future repositories/projects.
• Make your project easy to maintain with 8 issue templates.
• Quickstart your documentation with personalized readme badges and a cool readme structure.
• Manage your issues with 20 issue labels created just for you!
• 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.
• To start using it; "click use this template" and create your new repository,
• All the basic setup is made through an easy script that will auto-detect all your data to make it lightning fast! 🗲🗲 clone your new repository and execute the SETUP_TEMPLATE.sh shell script to personalize the files with your private details. Check how to execute it here.
• All the markdown follows MarkdownLint rules.

---

⚡ Installation

1. To create a new repository from this template generate your new repository from this template for more information or guidance, follow the Github guide.

2. Install the 🤖 used Github bots (recommended)

3. Clone your new repository generated from this template and cd into it.

4. Execute the SETUP_TEMPLATE.sh shell script to customize the files with your data.

   bash SETUP_TEMPLATE.sh

   Or

   ./SETUP_TEMPLATE.sh

   Additionally, watch this video to see how to execute the script or use bash SETUP_TEMPLATE.sh --help to obtain some extra information.

   If the automatic detection of the username, project name or email is NOT right, please post an issue, and you can manually correct them using the optional arguments like: bash SETUP_TEMPLATE.sh --username=whatever --projectName=whatever --email=whatever --projectType=whatever

5. Review every single file and customize it as you like.

6. Build your project. 🚀

⚠️ Customize every file to fit your requirements ⚠️

---

📚 What does it include?

1. A SETUP_TEMPLATE.sh script that MUST be executed right when you clone your repository. The script will customize all the data with yours in all the files.

   1. A README template file with a default template to start documenting your project. (it includes personalized badges and text with your project details)
   2. A CHANGELOG template file based on Keep a Changelog.
   3. An issue_label_bot.yaml file to use the issue adder Github bot. Activate it or check its documentation.
   4. A config.yml file to modify multiple bot's behaviours.
   5. A settings.yml file to use the popular settings Github bot. Activate it or check its documentation.
   6. A CONTRIBUTING explaining how to contribute to the project. Learn more with the Github guide.
   7. A SUPPORT explaining how to support the project. Learn more with the Github guide.
   8. A SECURITY with a guide on how to post a security issue. Learn more with the Github guide.
   9. A CODEOWNERS with the new user as the main owner. Learn more with the Github guide.
   10. A CODE_OF_CONDUCT with a basic code of conduct. Learn more with the Github guide.
   11. A PULL_REQUEST_TEMPLATE with a template for your pull request that closes issues with keywords. Learn more with the Github guide.
   12. Multiple issues templates. Learn more with the Github guide.
       1. A config.yml with the config and information about the issue templates.
       2. A Blank issue template with the super basic stuff, all the issues should contain.
       3. A Bug issue template.
       4. A Failing test issue template.
       5. A Documentation issue template.
       6. A Feature request issue template.
       7. A An Enhancement request issue template.
       8. A Security report issue template.
       9. A Question or support issue template.

---

🌲 Project tree

Files that will get removed after the execution of SETUP_TEMPLATE.sh are not shown! 🙈

.
├── CHANGELOG.md
├── .github
│   ├── 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
│   │   ├── 5-enhancement-request.md
│   │   ├── 6-security-report.md
│   │   ├── 7-question-support.md
│   │   └── config.yml
│   ├── ISSUE_TEMPLATE.md
│   ├── pull_request_template.md
│   ├── SECURITY.md
│   ├── settings.yml
│   └── SUPPORT.md
├── .gitignore
└── README.md

2 directories, 22 files

---

📝 Additional notes

• After generating your new repo with this template, 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 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.
  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

These are recommended bots that are prepared and configured for this template. If you install them your coding experience will probably be much better. We deeply recommend at least installing the issue label bot as this bot is the one that adds all the labels used in the issue templates.

1. The issue_label_bot.yaml file depends on the issue label bot (✓ highly recommended).
2. The settings.yml file depends on the settings label bot (optional).
3. The config.yml file depends on the bot welcome bot and todo bot (optional).

---

📸 Screenshots

A couple of screenshots to delight you before you use this template.

🔺 All the issue templates

🔻 An issue template opened

📘 The README template

Badges and texts will be replaced with your project details!

Or watch this video to see the whole README template.

🔖 The labels for your issues

If the bot probot-settings is not installed you will not have these beautiful labels! (there are actually more issue labels than in the image!)

📝 The CHANGELOG template

(project name and project type will be replaced with yours)

🛡️ Security policy

💼 Community profile at 100%

---

🕵️ Extra recommendations

For the right maintenance of the CHANGELOG.md, we recommend this VSCode extension and the read and understanding of the keep a changelog guide. Read and comment about it in this dev.to post. We also recommend installing all the used bots.

💉 Project tests

If you want to improve the development of this project, you must, after changing or improving whatever, run the project's tests to prove that they are working.

To do so:

bash tests/TESTS_RUNNER.sh

---

🍰 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's README.md so everyone can see your kindness and visit your content ⭐.

---

🎉 Was the template helpful? Help us raise these numbers up

Enjoy! 😃

⚠️ Remember that this template should be reviewed and modified to fit your requirements. The script SETUP_TEMPLATE.sh should be executed right when you clone your new repository generated from here. There will be files that will need manual revision ⚠️

Made with a lot of ❤️❤️ by @Josee9988