Repository Template

A starter template for my repositories.

Table of Contents

• Repository Template
  • About
  • Setup
  • License

About

This template repository is set up to support the following:

• Git (obviously)
  • A .gitattributes file has been pre-configured to treat all files as text with Unix-style (LF) line endings except for .cmd and .bat files. These files are treated as text files with Windows-style (CRLF) line endings.
  • A .gitignore file has been pre-configured to ignore most Visual Studio Code files except extensions.json, tasks.json, launch.json, and any .code-snippets files. It also ignores any Vim-related files, log files (*.log*), and local environment files (.env*).
  • A .gitconfig file has been pre-configured to support properly managing line endings inside the repository using the correct core.autocrlf setting (false).
• pre-commit
  • .pre-commit-config.yaml file is provided with some relatively sane default hooks. Feel free to adjust to your liking.
• EditorConfig
  • A pre-configured .editorconfig file is provided which treats all files as UTF-8 encoded files with Unix-style (LF) line endings except for .cmd and .bat files. Those are have Windows-style (CRLF) line endings.
  • Additionally all files are indented with spaces, 4 per indentation level, except .yaml or .yml files. Those are indented with 2 spaces per indentation level.
  • The file is pre-configured to insert a final newline as per the POSIX standard.
  • Finally, the file is configured to trim trailing whitespace.
• Visual Studio Code
• GitHub
  • Integration with Visual Studio Code
• GitHub Pull Requests
  • Integration with Visual Studio Code
• GitHub Actions
  • Integration with Visual Studio Code
• CSpell Spell Checker
  • A cspell.json is pre-configured to be read-only and use a set of project-specific dictionary provided at .cspell/dictionaries/project.txt.
  • The above mentioned dictionary configurations are located at .cspell/configs/.

Setup

1. Run ./scripts/setup-git-hooks.sh to install Git hooks into your local Git configuration (including pre-commit).

• Done

2. Set up GitHub labels from the .github/labels.yaml file (if applicable).

• Done

3. Set up GitHub rulesets from the files inside .github/samples/rulesets (if applicable).

• Done

4. Update GitHub Dependabot setup (if applicable).

• Done

5. Enable VSCode integrations.

• Done

6. Update the following files:
   • README.md
     • Update the title.
     • Update the description.
     • Remove everything else except license.
   • LICENSE.md
     • Change license to your project license.
   • CONTRIBUTING.md
     • Update code style guidelines (if applicable).
   • CODE_OF_CONDUCT.md
     • Update project administrators (if applicable).
   • SECURITY.md
     • Update where to report security vulnerabilities.
     • Update support versions table.
   • .cspell/dictionaries/project.txt
     • Remove all words and add those you do need.
   • .github/FUNDING.yml
     • Add your funding information (if applicable).
   • .github/CODEOWNERS
     • Set your code owners (if applicable).
7. Good to go!

• Yay!

License

Copyright (c) 2025 to present G'lek Tarssza

Licensed under a customized MIT license.

See LICENSE.md for the full license.