ScooterGitTemplate

ScottKirvan/ScooterGitTemplate

Nulla nobis dicta iste minus dolor repellendus aspernatur atque

View Demo · Documentation · Report Bug · Request Feature

ScooterGitTemplate is voluptatibus magni nemo est. Nulla nobis dicta iste minus dolor repellendus aspernatur atque. Earum expedita aut inventore tempora fugiat deleniti. Molestias minima nam expedita beatae totam ipsa reprehenderit animi. Occaecati quibusdam beatae ducimus voluptate ut doloribus vitae amet. Quia ut ut voluptate dignissimos adipisci dolorum rem.

Getting Started with This Template

[!IMPORTANT] Customization Checklist - After creating a repository from this template, customize these items:

Update the project description (line 5 above and in repository settings)

Replace assets/media/logo.jpg with your project logo

Update or remove the “View Demo” link (line 35)

Update or remove the Discord badge/link (lines 28-31)

Choose and apply a .gitignore from .github/gitignore-templates/ (see gitignore templates)

Update the version in .release-please-manifest.json to your starting version (e.g., “0.1.0”)

Fill in the Features, Installation, and Usage sections below

Review and update the Code of Conduct contact information

Enable GitHub Pages in repository settings if you want a project website

Remove or update this checklist section

Branches

main is the deployed branch. The repo doesn’t currently contain any other historic or dev branches.

Repo Layout

ScooterGitTemplate
├───_layouts                     # Jekyll layouts for GitHub Pages
├───.github
│   ├───gitignore-templates      # Example .gitignore files (Unreal, Unity, Python, etc.)
│   ├───ISSUE_TEMPLATE           # Bug report and feature request templates
│   ├───release-please           # Release-Please configuration
│   ├───workflows                # GitHub Actions (release, template-init)
│   ├───FUNDING.yml              # Sponsorship configuration
│   └───PULL_REQUEST_TEMPLATE.md # PR template
├───assets
│   ├───css                      # Styling for GitHub Pages
│   └───media                    # Images and logos
├───notes                        # CHANGELOG, VERSION, TODO
├───CODE_OF_CONDUCT.md           # Community guidelines
├───CONTRIBUTING.md              # Contribution guidelines
├───LICENSE.md                   # MIT License
└───README.md                    # This file

Key Features

GitHub Pages Support: The _layouts and assets/css folders enable GitHub Pages rendering with a custom dark theme similar to GitHub’s Dark High Contrast theme. Enable Pages in your repo settings - see GitHub’s Jekyll documentation.

Automated Release Management: The .github/workflows folder includes Release-Please for automated versioning and CHANGELOG updates based on conventional commits.

Template Initialization: The template-init.yml workflow automatically updates repository references when you create a new repo from this template, then deletes itself.

.gitignore Templates: The .github/gitignore-templates/ folder contains ready-to-use .gitignore files for Unreal Engine, Unity, Python, Node.js, C++, and general development. See the templates README for usage.

[!NOTE] When using this template project, do not clone the tags or branches. Stick with main as the name of your main release branch. Change the version number in the .release-please-manifest.json file to the version you want to start with.

Release-Please uses Conventional Commits with Semantic Versioning (version: MAJOR.MINOR.PATCH). Changes to version numbers are triggered by specific keywords in your commit messages:

feat: (new feature) will bump the MINOR version number.

fix: (bug fixes) will bump the PATCH number.

feat!: fix!: or any xxx!: (major and breaking changes) will bump the MAJOR version number.

[!TIP] Automatic Template Initialization: When you create a new repository from this template, a GitHub Actions workflow automatically runs on your first push to update all repository references, URLs, and badges in the README with your new repository information. The workflow then deletes itself to keep your repo clean. No manual setup required!

Branches
Repo Layout
Features
Installation
Usage
Contributions / Contact
Credits

Features

Installation ———— Usage —–

Contributions / Contact

Please file an issue, or grab a fork, hack away, and submit a pull request.
Contact me at linkedin.com/in/scottkirvan/
You can also contact me at my discord server, I’m cptvideo.

Credits

Project Link: ScooterGitTemplate
CHANGELOG
TODO