⚠️ This is a specially-named repository which GitHub treats differently to other repositories. Find out more
✨ This repository is configured as a Public Template - which means you can use it as the basis for your own repositories (and automatically include ALL files in this repository) just by clicking HERE
This repository was created with 2 purposes in mind:
- To serve as my default & community health files repository
- To serve as a template for YOU to use when creating your own repositories
Why would you do that? Because I've been quite pedantic about assembling EVERY file you need to create a well-supported, healthy community for your project so that YOU DON'T HAVE TO!
Seriously, this project has every file a GitHub project could possibly need, all ready and waiting for you to edit them and make them your own!
(See What's Included for a list of files)
| Branch | Stability | Code Age | Reliability |
|---|---|---|---|
master |
latest stable | latest release | 🟢 |
develop |
latest unstable | most recent code | 🔴 |
release/* |
stable | tagged versions | 🟡 |
gh-pages/master |
latest stable | latest release | 🟢 |
gh-pages/develop |
latest unstable | most recent code | 🔴 |
gh-pages/release/* |
stable | tagged versions | 🟡 |
This template repository contains everything you need to build a well-supported, healthy community around your GitHub repo!
- A README-TEMPLATE - which not only looks great, it includes a collapsable Table of Contents with links to suggested section headings
- COMMUNITY HEALTH FILES:
- CODE OF CONDUCT - based on the standard Contributor Covenant. Learn More
- CONTRIBUTING - a basic guide for your project's 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 to define who owns what code. Learn More
- PULL REQUEST TEMPLATE - a default Pull Request Template for contributors. Learn More
- FUNDING - a file which adds a sponsorship button to your repo. Learn More
- Dependabot - a default config file for Dependabot (security bot). Learn More
- Multiple Issues Templates
- Bug Issue Template
- Documentation Issue Template
- Feature Request Template
- Question / Support Issue Template
- config.yml - configuration file for issue templates
- Common Configuration Files
- .all-contributorsrc - config for all-contributors bot
- .editorconfig - commonly-used and well-supported config for code editors
- .gitattributes - config file ensuring git doesn't screw up line endings
- .gitignore - every repository should have one ...
- .licrc - config for Licensebat software license compliance app
- .releaserc - config for my Release Manager project (you'll love it - promise!)
- ESSENTIAL FILES
- CITATION - helps others correctly cite your repo
- COPYRIGHT - your statement of copyright + a place to list attributions
- LICENSE - a copy of the MIT license. Learn More
In a directory of their own (so they don't cause you any unexpected issues) you can find a collection of config files for recommended GitHub Apps that I thought you might find useful.
- Welcome Bot - configured by
.github/.bots/config.ymlLearn More - Sentiment Bot - configured by
.github/.bots/config.ymlLearn More - All Contributors - configured by
.all-contributorsrcLearn More
- Stale Bot - configured by
.github/.bots/stale.ymlLearn More - No Response Bot - configured by
.github/.bots/no-response.ymlLearn More
If you want to reliably manage labels for each of your repositories, I'd recommend you take a look at GH-Label. It takes a little more setup than others, but it's worth it in the long run. Honestly, I tried the Settings Bot and a couple of other workflow-based solutions, but the just didn't perform consistently at all whenever I had more than 10 labels configured. Don't waste your time trying to use anything else.
Installation literally couldn't be any easier - you've got 2 choices:
- Use this repo as a template for your own
- Fork this repo and edit as you see fit
Then you just need to install and configure any GitHub Apps you want to include, and customize any of the other files as you require.
🔐 Security
While all of my repositories follow good security practices, 100% security can never be guaranteed in any software package. My Community Health Files & Repository Template is provided AS IS, and without warranty. You can find more details in the LICENSE file included with this repository.
If you discover any issue regarding the security of this project, please disclose that information responsibly by sending an email to security@ragdata.dev. PLEASE DO NOT CREATE AN ISSUE OR DISCUSSION TOPIC. You can read more about this project's security policies HERE
Read the Community Support Document
🔸
Issues Register 🔸 Documentation
🔸
🔸
Connect with my Social Channels
If you'd like to make a contribution of code, then please see my Contributor's Guide
It's not just contributions of 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 part of this project - thanks to the All-Contributors bot.
The creation and maintenance of Open Source Software is definitely a labour of love - this is never going to be a path to riches. The truth is, it takes not only a lot of time, it creates a substantial amount of personal expense (even when you're working on a shoestring) to keep these projects freely available for all.
If you'd like more info about how you can help out, head to my Sponsor's Page
📄 License
MIT License
Copyright © 2022-2023 Darren (Ragdata) Poulton
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.
- Probot
- Code Security
- GitHub Issues
- Building Communities
- About Community Profiles for Public Repositories
- About Issue & Pull Request Templates
- The README Project
- GitHub Sponsors
- GitHub Skills
If this project is worth something to you, and you're in a position to be able to help out financially, it would really take the pressure off here and allow me to keep working and keep it all freely available!
It doesn't have to be a lot, but you will magnify your contribution if you're able to give a little every month. If you're not in a position to do that, but think you could make a small, one-time donation to the kitty - you'd be AMAZED how I can make a little go a LONG way!
EVERY financial supporter gets their name associated with the project.
Find out more on my Sponsor's Page