grahamsedman opened a new pull request, #10: URL: https://github.com/apache/trafficserver-libswoc/pull/10
This pull request introduces a comprehensive cleanup and restructuring of the `.gitignore` file for `libswoc`. The goal is to enhance overall readability, remove duplicate/redundant entries, add missing ignore patterns for common modern development tooling (such as VS Code and Code::Blocks), and enforce a logical, consistent structure. --- ### **Key Changes** 1. **Improved Headers and Comments**: * Refined section headers to be more concise and consistent (e.g., changed "Compiled Object files" to "Compiled Objects"). 2. **Logical Grouping of Entries**: * Grouped related file types and directories under descriptive headers (e.g., "Shared Libraries", "Build Directories"). 3. **Added Missing Entries**: * Included `*.cbp` (Code::Blocks project files) and `.vscode/` (Visual Studio Code configuration directories) to prevent tracking local IDE/editor configurations. 4. **Removed Redundancies**: * Cleaned up duplicate entries (e.g., `*.swp`, `*.pc`, `.parts.cache`, `.sconsign.dblite`) to prevent confusion and streamline upkeep. 5. **Logical Ordering**: * Reordered sections into a predictable sequence—starting with compiled artifacts, followed by build directories, configuration files, and miscellaneous items. 6. **Clarified Sections**: * Added descriptive comments for context-specific sections (e.g., "Example Executables", "Test Executable"). 7. **Added New Sections**: * Added explicit tracking exclusions for Compilation Databases (`/compile_commands.json`) and Cache Directories (`/.cache/`). --- ### **Benefits** * **Improved Readability**: Clear headers and consistent styling make the file much easier to scan. * **Easier Maintenance**: Logical grouping and zero redundancies reduce friction when updating rules. * **Comprehensive Coverage**: Ensures modern development files and caches are reliably excluded from version control. * **Consistency**: Standard naming conventions and structure layout across the file. --- ### **References / Comparison** * **Current Version (.gitignore)**: [[View on master](https://github.com/apache/trafficserver-libswoc/blob/master/.gitignore)](https://github.com/apache/trafficserver-libswoc/blob/master/.gitignore) * **Refactored Version (.gitignore)**:[[View on branch](https://github.com/grahamsedman/trafficserver-libswoc/blob/chore/C-001-format-gitignore-add-tooling-vscode-support/.gitignore)](https://github.com/grahamsedman/trafficserver-libswoc/blob/chore/C-001-format-gitignore-add-tooling-vscode-support/.gitignore) -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
