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 7 issue templates.
• 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", create your new repository, clone your new repository and execute the SETUP_TEMPLATE.sh shell script to personalize the markdowns with your private details. Check how to execute it here.
• All the markdown follows MarkdownLint rules.

---

How to use it as a template for my new repositories? 🚀

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. Clone your repo and cd into it.

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

   bash SETUP_TEMPLATE.sh # execute the setup script.

   Or you can also do it like this:

   chmod u+x SETUP_TEMPLATE.sh && ./SETUP_TEMPLATE-sh # another way of executing it

   Additionally, watch this video to see how to execute the script.

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

5. 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 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
   1. An issue_label_bot.yaml file to use the popular Github bot. Activate it or check its documentation.
   2. A CONTRIBUTING explaining how to contribute to the project. Learn more with the Github guide.
   3. A SUPPORT explaining how to support the project. Learn more with the Github guide.
   4. A SECURITY with a guide on how to post a security issue. Learn more with the Github guide.
   5. A CODE_OF_CONDUCT with a basic code of conduct. Learn more with the Github guide.
   6. A PULL_REQUEST_TEMPLATE with a template for your pull request that closes issues with keywords. Learn more with the Github guide.
   7. 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 Security report issue template.
      8. A Question or support issue template.

---

Project tree 🌲

.
├── CHANGELOG.md
├── SETUP_TEMPLATE.sh (will get removed)
├── .github
│   ├── CODE_OF_CONDUCT.md
│   ├── 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-security-report.md
│   │   ├── 6-question-support.md
│   │   └── config.yml
│   ├── ISSUE_TEMPLATE.md
│   ├── pull_request_template.md
│   ├── SECURITY.md
│   └── SUPPORT.md
├── .gitignore
├── LICENSE (will get removed)
└── README.md

2 directories, 20 files

---

Extra recommendations 🕵️

• 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 perform 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.

---

Screenshots 📷

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

• All the issue templates.

• An issue template opened.

• Security policy

• Community profile at 100%

---

For the right maintenance of the CHANGELOG.md, we recommend this VSCode extension and the read and understanding of the keep a changelog guide.

---

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. There will be files that will need manual revision⚠️

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