Skip to content

SgtSwagrid/git-config

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

⚙️ Git Config

The single source of truth for basic configuration across many of my projects on GitHub.

👷 What's the workflow?

Changes made to the configuration files contained herein are automatically copied into each dependent project using GitHub Graph. Updates to these files should be made here, not in any of the downstream repositories, lest they be overwritten later.

📋 What's included?

  • Git settings including .gitignore and .gitattributes.
  • Basic IDE configuration in .editorconfig.
  • The MIT license, which I tend to use by default as it is fairly permissive.
  • Configuration for github-rules to define GitHub rulesets in-source.
  • Claude Code integration with GitHub.

🏗️ Where is this used?

The full list of projects that rely on this configuration is defined in graph.json.

🤔 Should I use this in my projects too?

Only if you want to, but this exists mainly for my own convenience. I would, however, argue that these settings are reasonable defaults for many projects.

🔨 How can this be used?

You have several options:

  1. If you want continuous updates as this repository evolves, open a PR to add your project(s) to graph.json. You'll also need to send me a PAT with write access to the corresponding repositories.
  2. If you want continuous updates, but want to deviate from my template according to your own needs, fork this repository and then add your project(s) to graph.json (after removing the existing projects from the list). In this case, you can add the PAT yourself.
  3. If you just want the settings without the updates, click 'Use this template' on GitHub (for a new project), or simply copy and paste the files (for an existing project).

👁️ See also

Scala Config is a downstream template for Scala projects in particular.

About

⚙️ The single source of truth for basic configuration across many of my projects on GitHub, with automatic synchronisation by GitHub Graph.

Resources

License

Stars

Watchers

Forks

Contributors