GitHub Best Practices

Use .gitignore

Use a .gitignore file in the root of every repo to exclude files that should never be committed.

Here’s an example of the .gitignore from our documentation repository.

Example .gitignore

.env
deploy.toml
test
test.toml
.htmltest.*.yaml
node_modules
.build-harness
build-harness/
public/*
algolia/*
tmp/*
.gitkeep
*.swp
.idea
*.iml
package-lock.json
static/components/*
utterances/*

themes/cloudposse/static/css/*
themes/cloudposse/static/js/*
static/webfonts/*
static/css/*
static/js/*