SETUP_TEMPLATE.sh
shell script to personalize the files with your private details. Check how to run it here.To create a new repository from this template, generate your new repository from this template; for more information or guidance, follow the GitHub guide.
Install the ๐ค used GitHub bots (recommended)
Clone your new repository generated from this template and cd
into it.
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 correct, 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
Review every single file and customize it as you like.
Build your project. ๐
โ ๏ธ Customize every file to fit your requirements โ ๏ธ
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.
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
After generating your new repo with this template, make sure to, right after you clone it, run the script SETUP_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 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:
bash SETUP_TEMPLATE.sh
or chmod 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 the issue label bot as this bot is the one that adds all the labels used in the issue templates.
issue_label_bot.yaml
file depends on the issue label bot (โ highly recommended).settings.yml
file depends on the settings label bot (optional).config.yml
file depends on the bot welcome bot and to-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 watch [this video](https://gifs.com/gif/josee9988-s-readme-md-MwO5E3) to see the whole README template.
If the bot probot-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 this VSCode extension and the read and understanding of the keep a changelog guide. Please read and comment about it in this dev.to post. We also recommend installing all the used 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, and you 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 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