Skip to content

Commit 8048318

Browse files
committed
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.
1 parent 9d057cd commit 8048318

1 file changed

Lines changed: 9 additions & 1 deletion

File tree

index.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ TWINE_PASSWORD={token} tox -e release
188188

189189
## Ignoring Artifacts
190190

191-
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.
191+
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.
192192

193193
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`:
194194

@@ -203,6 +203,14 @@ As you can see, this file contains all of the commonly encountered ignorables wh
203203

204204
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.
205205

206+
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:
207+
208+
```shell
209+
wget https://raw.githubusercontent.com/jaraco/dotfiles/main/.gitignore_global -O - >> .git/info/exclude
210+
```
211+
212+
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.
213+
206214
# Challenges
207215

208216
Because this approach applies concerns across repos, it does violate some assumptions leading to undesirable outcomes.

0 commit comments

Comments
 (0)