Repository files navigation

• This template can be used as a base layer for any of your future repositories/projects.
• Make your project easy to maintain with8 issue templates.
• Quick start your documentation with personalizedREADME badges and an extraordinary README structure.
• Manage your issues with20 issue labels created just for you!
• Make yourcommunity healthier with all the guides like code of conduct, contributing, support, security...
• Learn more with theofficial 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 theSETUP_TEMPLATE.sh shell script to personalize the files with your private details. Check how to run ithere.
• All the markdown follows"MarkdownLint" rules.

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

2. Install the🤖 used GitHub bots (recommended)

3. Clone your new repositorygenerated from this template andcd into it.

4. Execute theSETUP_TEMPLATE.sh shell script tocustomize the files with your data.

   bash SETUP_TEMPLATE.sh

   Or

   ./SETUP_TEMPLATE.sh

   Additionally, watchthis video to seehow to execute the script or usebash SETUP_TEMPLATE.sh --help to obtain some extra information.

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

5. Review every single file andcustomize it as you like.

6. Build your project. 🚀

⚠️Customize every file to fit your requirements⚠️

1. ASETUP_TEMPLATE.sh script thatMUST 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 onKeep a Changelog.
   3. Anissue_label_bot.yaml file to use the issue adder GitHub bot.Activate it or check its documentation.
   4. Aconfig.yml file to modify multiple bot's behaviours.
   5. Asettings.yml file to use the popular settings GitHub bot.Activate it or check its documentation.
   6. ACONTRIBUTING explaining how to contribute to the project.Learn more with the GitHub guide.
   7. ASUPPORT explaining how to support the project.Learn more with the GitHub guide.
   8. ASECURITY with a guide on how to post a security issue.Learn more with the GitHub guide.
   9. ACODEOWNERS with the new user as the principal owner.Learn more with the GitHub guide.
   10. ACODE_OF_CONDUCT with a basic code of conduct.Learn more with the GitHub guide.
   11. APULL_REQUEST_TEMPLATE with a template for your pull request that closes issues with keywords.Learn more with the GitHub guide.
   12. Multipleissues templates.Learn more with the GitHub guide.
       1. Aconfig.yml with the config and information about the issue templates.
       2. ABlank issue template with the super basic stuff, all the issues should contain.
       3. ABug issue template.
       4. AFailing test issue template.
       5. ADocumentation issue template.
       6. AFeature request issue template.
       7. AnEnhancement request issue template.
       8. ASecurity report issue template.
       9. AQuestion or support issue template.

Files that will get removed after the execution ofSETUP_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.md2 directories, 22 files

• Aftergenerating your new repo with this template, make sure to, right after you clone it, run the scriptSETUP_TEMPLATE.sh.

• Then, after 'cloning' the repository you will be presented with all the files modified with your project details and information. It is essential tomanually 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 usingWindows and you don't know how to execute theSETUP_TEMPLATE.sh script:

  1. Installgit for Windows.
  2. Right-click on the git repository folder and click "git bash here".
  3. Then just performbash SETUP_TEMPLATE.shorchmod u+x SETUP_TEMPLATE.sh && ./SETUP_TEMPLATE.sh.

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 sincerely recommend at least installing theissue label bot as this bot is the one that adds all the labels used in the issue templates.

1. Theissue_label_bot.yaml file depends on theissue label bot (✓ highly recommended).
2. Thesettings.yml file depends on thesettings label bot (optional).
3. Theconfig.yml file depends on the botwelcome bot andto-do bot (optional).

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

Badges and texts will be replaced with your project details!

Or watchthis video to see the whole README template.

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

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

For the proper maintenance of the CHANGELOG.md, we recommend thisVSCode extensionand the read and understanding of thekeep a changelog guide.Please read and comment about it in thisdev.to post.We also recommend installing all theused bots.

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

We are currently looking for new donators to help and maintain this project! ❤️

By donating, you will help the development of this project, andyou will be featured in this project's README.md, so everyone can see your kindness and visit your content ⭐.

Enjoy! 😃

⚠️ Remember that this template should be reviewed and modified to fit your requirements.The scriptSETUP_TEMPLATE.sh should be executed right when you clone your new repository generated fromhere.There will be files that will needmanual revision⚠️

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