- Overview
- Installation
- What's Included
- Screenshots
- Author / Maintainer
- Contributors
- Supporters
- Copyright & Attributions
- License
- Resources
This project is intended to be used as the basis for other projects. As such, it provides everything a good GitHub project needs including:
- Issue Templates
- GitHub Workflows
- Release Script
- Community Health Docs
- Pre-Configured Probot Apps
- Issue Labels
- and more!
- Create your new repository using this repo as a template
- (if you name your new repository
.githubit will be the default for ALL of your other repos)
- (if you name your new repository
- Install and configure Probot Apps
- Customise ALL files according to your needs
- A README template with all the information every project needs!
- Community Health Docs:
- CODE OF CONDUCT - the standard Contributor Covenant. Learn more
- CONTRIBUTING - a guide for your project contributors. Learn more
- SECURITY - a default Security Policy for your project. Learn more
- SUPPORT - a template for listing project support options. Learn more
- CODEOWNERS - a template defining who owns what code. Learn more
- PULL REQUEST TEMPLATE - a default Pull Request template for contributors. Learn more
- Multiple Issue Templates:
- Bug Issue Template
- Documentation Issue Template
- Feature Request Template
- Question / Support Issue Template
- config.yml - configuration file for issue templates.
The following bots are configured and ready to use with this template, and installing them will ultimately improve your coding experience. If you only install one of them it should be the Settings Bot, as this little beauty makes it quick and easy for you to configure your whole repo. You can see a list of all available probot apps here. The bots listed below have all been configured for use with this project template:
- Settings Bot - configured by
.github/settings.yml - Welcome Bot - configured by
.github/config.yml - Sentiment Bot - configured by
.github/config.yml
- Stale Bot - configured by
.github/stale.yml - No Response Bot - configured by
.github/no-response.yml - All Contributors Bot
- Unfurl Links Bot
Use either as an npn script:
npn run release <options>Or from the command line under bash:
bash scripts/bump.sh <options>Where <options> are:
-u, --user Git user name (optional) Default: $USER_NAME
-e, --email Git user email (optional) Default: $USER_EMAIL
-m, --message Commit message (optional) Default: 'chore(release): release vX.X.X'
-b, --branch Git branch (optional) Default: master
-p, --preview Preview Mode (optional) Default: false
-t, --type [patch|minor|major] (optional) Default: patch
- The 'type' argument is a special one:
- Preview: preview
- First Release: first-release
- Pre-Release: prerelease [optional name] - eg: prerelease alpha = 1.0.0-alpha.0
- Patch Release: patch
- Minor Release: minor
- Major Release: major
- Force Version: release-as [prerelease|minor|major|X.X.X] (where X.X.X is a version number)NOTE: If you're going to use this script in
npnmode, you need to remember to pass any arguments like so:npn run release -- --previewOR
npn run release -- -u "Ragdata"Without the extra '--' preceding your arguments,
npnwill assume that any arguments were intended for it to consume and it will eat them on you.
Once the script has run, if you're happy with the results, you'll need to push the tag manually:
git push origin v0.1.1Use either as an npn script:
npn run setupOr from the command line under bash:
bash scripts/setup.sh
If you'd like to make a contribution of code, then please see my Contributor's Guidelines
It's not just code that I'm looking for though. If you have any ideas or suggestions about how this project may be improved, don't hesitate to open an Issue and let me know! Contributions of ALL kinds will be recognised here if they are made a part of this project.
It takes not just a lot of time, but a certain amount of personal expense to make this software available free-of-charge. If you've found this or any of my projects useful in some way and would like to help out, even the smallest of contributions would go a long way towards helping me to keep them freely available to the community.
For more info, head to my sponsor's page.
This project incorporates ideas and / or code crafted by the following talented individuals:
-
Josee9988/project-template
Copyright © 2020 Jose Gracia Berenguer
MIT Licensed -
cotes2020/jekyll-theme-chirpy
Copyright © 2019 Cotes Chung
MIT Licensed
"We see much further, and reach much higher,
only because we stand upon the shoulders of giants"
MIT License
Copyright © 2022 Darren Poulton (Ragdata)
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
