Skip to content

Commit 88fa842

Browse files
authored
Revise best practices for ignore files section
Updated best practices for ignoring files in version control.
1 parent 2bfa129 commit 88fa842

File tree

1 file changed

+23
-12
lines changed

1 file changed

+23
-12
lines changed

docs/references/ignore-files.md

Lines changed: 23 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -331,24 +331,35 @@ node_modules/
331331
332332
### What to Ignore
333333
334-
✅ **Dependencies**: `node_modules/`, `vendor/`, `venv/`, etc.
335-
✅ **Build artifacts**: `dist/`, `build/`, `target/`, compiled binaries
336-
✅ **Local configuration**: `.env`, `.env.local`, local config files
337-
✅ **IDE/Editor files**: `.vscode/`, `.idea/`, editor-specific files
338-
✅ **Temporary files**: `*.log`, `*.tmp`, `*.swp`
339-
✅ **OS files**: `.DS_Store`, `Thumbs.db`
334+
**Dependencies**: `node_modules/`, `vendor/`, `venv/`, etc.
335+
336+
**Build artifacts**: `dist/`, `build/`, `target/`, compiled binaries
337+
338+
**Local configuration**: `.env`, `.env.local`, local config files
339+
340+
**IDE/Editor files**: `.vscode/`, `.idea/`, editor-specific files
341+
342+
**Temporary files**: `*.log`, `*.tmp`, `*.swp`
343+
344+
**OS files**: `.DS_Store`, `Thumbs.db`
345+
340346
341347
### What NOT to Ignore
342348
343-
❌ **Source code**: Your application source files
344-
❌ **Required configuration**: Production configs that need to be deployed
345-
❌ **Dockerfiles**: If you use custom Dockerfiles
346-
❌ **Package files**: `package.json`, `requirements.txt`, `go.mod` (unless you have a good reason)
347-
❌ **Documentation**: README, docs that should be included
349+
**Source code**: Your application source files
350+
351+
**Required configuration**: Production configs that need to be deployed
352+
353+
**Dockerfiles**: If you use custom Dockerfiles
354+
355+
**Package files**: `package.json`, `requirements.txt`, `go.mod` (unless you have a good reason)
356+
357+
**Documentation**: README, docs that should be included
358+
348359
349360
### Security Considerations
350361
351-
⚠️ **Important**: The ignore feature excludes files from the tarball, but this is not a security feature. Sensitive files should not be in your repository in the first place.
362+
**Important**: The ignore feature excludes files from the tarball, but this is not a security feature. Sensitive files should not be in your repository in the first place.
352363
353364
- Never commit secrets, API keys, or passwords to version control
354365
- Use environment variables or secret management for sensitive data

0 commit comments

Comments
 (0)