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.

.gitignore example

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

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