Introduction
Most of us spend countless hours on multiple open-source projects and sometimes we are doing the same basic work in all of them; design catchy documentation in the readme file, write an issue and pr templates, etc.
When I discovered the Github templates I soon realized I wanted to do a global and unique template to use in all my future projects.
Quick overview
I want to show you how you could improve your new repositories using this template and what it contains:
Organize your issues and improve your productivity with these 9 issue templates.
Create your project with an essential readme structure and some cool badges (When downloading the template all the texts and badges will be personalized with your project details)
19 issue labels to organize your issues
Log all your changes in your new CHANGELOG file
Get control over your community
Installation
If you liked it, maybe it's time for trying it!
- To create a new repository from this template generate your new repository from this template for more information or guidance, follow the Github guide.
- Clone your repo and
cd
into it. -
Execute the
SETUP_TEMPLATE.sh
shell script to customize the files with your data.
bash SETUP_TEMPLATE.sh # execute the setup script. additional parameters [Username] [Project-Name] [Email]
Or you can also do it like this:
chmod u+x SETUP_TEMPLATE.sh && ./SETUP_TEMPLATE-sh # another way additional parameters [Username] [Project-Name] [Email]
Additionally, watch this video to see how to execute the script.
(the script will automatically auto-detect your mail, project name and username, but you can change them if they are wrong :D) Review every single file and customize it as you like.
Build your project. 🚀
Thanks for reading, for more information please check the repository :D
Top comments (4)
Nice template :)
Thanks for your support!
This is my first dev.to post so any feedback is highly appreciated! ❤️
Thanks everybody for the support the template is having!