DEV Community

loading...
Cover image for The ultimate Github project template

The ultimate Github project template

josee9988 profile image Jose Gracia Berenguer Updated on ・2 min read

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 8 issue templates.
image

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)
image

18 issue labels to organize your issues
image

Log all your changes in your new CHANGELOG file
image

Get control over your community
image


Installation

If you liked it, maybe it's time for trying it!

  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
    

    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. 🚀


Thanks for reading, for more information please check the repository :D

Discussion (3)

pic
Editor guide
Collapse
mkubdev profile image
Kubdev

Nice template :)

Collapse
josee9988 profile image
Jose Gracia Berenguer Author

Thanks for your support!

Collapse
josee9988 profile image
Jose Gracia Berenguer Author

This is my first dev.to post so any feedback is highly appreciated! ❤️