sellout / .github

Default community health files for `github:sellout` repos

Sellout’s .github

Default community health files for github:sellout repos

This repo is implicitly depended on by any other repo under the “sellout” user on GitHub. It contains files that are presented as if they are part of each repo unless that repo contains an overriding file.

More about this special repository can be found in GitHub’s docs.

It’s not apparent from the docs what the priority of the locations searched is, or whether this repo can have community health files distinct from the default ones it provides. As such, I’m assuming the following priority order:

1. the root of the repo
2. the .github directory
3. the docs directory
4. this repo’s root
5. this repo’s .github directory
6. this repo’s docs directory

With the restriction that some files (e.g., issue templates) must live in .github). It’s not obvious to me where files specific to this repo would live.

As such, I am putting GitHub-specific files in .github (issue templates, FUNDING.yml, etc.) and the rest in the root directory (or wherever they are likely to be found outside of GitHub – e.g., CONTRIBUTING.md).

development environment

We recommend the following steps to make working in this repo as easy as possible.

direnv allow
git config --local include.path ../.gitconfig

direnv allow

This command ensures that any work you do within this repo is done within a consistent reproducible environment. That environment provides various debugging tools, etc. When you leave this directory, you will leave that environment behind, so it doesn’t impact anything else on your system.

git config --local include.path ../.config/git/config

This will apply our repo-specific Git configuration to git commands run against this repo. It is very lightweight (you should definitely look at it before applying this command) – it does things like telling git blame to ignore formatting-only commits.