From 804831827d9be22a71085648ca811c4bc46f2dc5 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Tue, 2 Jul 2024 11:33:17 -0400 Subject: [PATCH] Expand section on ignoring artifacts to link to Git docs on configuration, techniques for appling the settings to a single repo, and references to GitHub Codespaces. --- index.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/index.md b/index.md index d48f3fff..1debdf78 100644 --- a/index.md +++ b/index.md @@ -188,7 +188,7 @@ TWINE_PASSWORD={token} tox -e release ## Ignoring Artifacts -This project does not include a `.gitignore` module because this project holds the philosophy that it's preferable to specify ignores at the most relevant level, and so .gitignore for a project should specify elements unique to _that project_ and not elements peculiar to the language or system or user. +This project does not include a `.gitignore` module or provides a very minimal one because this project holds the philosophy that it's preferable to specify ignores at the most relevant level, and so .gitignore for a project should specify elements unique to _that project_ and not elements peculiar to the language or system or user. Instead, skeleton recommends users to implement ignores for the language(s), system, and user in the development environment. For example, jaraco has the following in `~/.gitconfig`: @@ -203,6 +203,14 @@ As you can see, this file contains all of the commonly encountered ignorables wh It's not a perfect alignment of concerns to projects, but it's a dramatically simpler approach saving hundreds of commits that can be readily adopted by any user and is strongly recommended for skeleton-based projects. +See [gitignore docs](https://git-scm.com/docs/gitignore) for more details regarding configuring ignore files. For users only incidentally involved with skeleton-derived projects, consider downloading jaraco's `.gitignore_global` to the checked-out project: + +```shell +wget https://raw.githubusercontent.com/jaraco/dotfiles/main/.gitignore_global -O - >> .git/info/exclude +``` + + Note: See [dotfiles](https://docs.github.com/en/codespaces/setting-your-user-preferences/personalizing-github-codespaces-for-your-account#dotfiles) for guidance on applying these settings in GitHub Codespaces. + # Challenges Because this approach applies concerns across repos, it does violate some assumptions leading to undesirable outcomes.