⚠️ This is a specially-named repository which GitHub treats differently to other repositories. FIND OUT MORE
This repository serves a dual purpose:
Firstly, it provides default files and profile page for the RedEyed Technologies Organization at GitHub.
Secondly, it provides 2 templates that you can copy and use when setting up your own GitHub Organizations and Repositories.
The Branch Reliability Table is a way for you to determine how close to the bleeding edge you're comfortable getting.
If you need stability, then download a branch marked with 🟢
If you're contributing code to the project, you'll want 🔴
| Branch | Stability | Code Age | Reliability |
|---|---|---|---|
master |
latest stable | latest release | 🟢 |
develop |
latest unstable | most recent code | 🔴 |
Organization Profile Template:
The Organization Profile Template contains ALL the community health files and issue templates you need to create a full-featured, well-supported GitHub repository.
Subordinate Repository Template:
The Subordinate Repository Template contains just the essentials, and will use the community health files provided by the Organization's .github repository.
Organization Profile Template Contents:
- README TEMPLATE - which not only looks great, it includes a collapsable Table of Contents linking to all the most important headings a top-notch README file needs.
- COMMUNITY HEALTH FILES:
- CODE OF CONDUCT - based on the standard Contributor Covenant. Learn More
- GOVERNANCE POLICY - an in-depth document describing the rules governing your community. Learn More
- CONTRIBUTOR'S GUIDE - a basic guide for your project's contributors. Learn More
- SECURITY POLICY - a default Security Policy for your project. Learn More
- SUPPORT DOC - a template for listing project support options. Learn More
- PULL REQUEST TEMPLATE - a default Pull Request Template for contributors. Learn More
- CODEOWNERS - a template to define who owns what code. Learn More
- FUNDING - a file which adds a sponsorship button to your repo. Learn More
- Dependabot Config - a default config file for Dependabot (security bot). Learn More
- MULTIPLE ISSUE TEMPLATES:
- Common Configuration Files:
- .all-contributorsrc - config for all-contributors bot. LEARN MORE
- .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
- ESSENTIAL FILES:
- CITATION.cff - helps others correctly cite your repo
- CONTRIBUTORS - a template file for the all-contributors bot to use
- 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.
ESSENTIAL APPS:
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 they 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.
HIGHLY RECOMMENDED:
- Welcome Bot - configured by
.github/.bots/config.yml - Sentiment Bot - configured by
.github/.bots/config.yml - No Response Bot - configured by
.github/.bots/no-response.yml
Organization Profile Template:
Basically, all files except for those in the /template directory can be used to create your own Organization Profile. The easiest way to do this is to first create your new organization, then click here and create a new repository under your Organization named .github
Subordinate Repo Template:
When setting up repositories under your Organization Profile, you can use the files in the /template directory. The missing files will be read from the Organization's .github repository. To overwrite any of the files contained in the Organization's .github repo, include them here and GitHub will use the local versions instead.
📛 Badges
 |
JetBrains very generously provide me with a free license for their products every month, and you can get one too if you're working on a public, open-source project! I've used JetBrains' IDEs for many years now, and was more than happy to pay for a license every year back when I was working in the corporate sector. Absolutely my first choice in IDEs! |
If sponsorship isn't right for you, but you have found my work to be useful in some way,
would you please consider buying me a coffee to help keep me going?
🔐 Security
While the RedEyed Technologies Organization follows good security practices, 100% security can never be guaranteed in any software package. The RedEyed 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 a security advisory. PLEASE DO NOT CREATE AN ISSUE OR DISCUSSION TOPIC. You can read more about this project's security policies HERE
If you'd like to make a contribution, then please see the RedEyed Contributor's Guide
It's not just contributions of code that I'm looking for. 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.
⚖️ License
Copyright © 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.
- GitHub :: Building Communities
- GitHub :: Creating a default community health file
- GitHub :: Code Security
- GitHub :: Dependabot Quickstart Guide
