Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Re-organize .gitignore file to be parsed properly #4740

Merged
merged 3 commits into from
Nov 28, 2023

Conversation

aphedges
Copy link
Contributor

The file was re-organized in da652d01 with better documentation, but that unfortunately made the syntax invalid. According to the gitignore documentation:2

A line starting with # serves as a comment. Put a backslash ("\") in
front of the first hash for patterns that begin with a hash.

I needed to move the comments for Git to parse the file properly. To maintain readability, I added an extra # to the comments at the top of each section.

Footnotes

  1. https://github.com/microsoft/DeepSpeed/commit/da652d0e0b4ff0b7c870e74730b9d3d8f51bf8aa

  2. https://git-scm.com/docs/gitignore/2.43.0#_pattern_format

aphedges and others added 2 commits November 27, 2023 22:41
The file was re-organized in da652d0[^1] with better documentation, but
that unfortunately made the syntax invalid. According to the gitignore
documentation:[^2]

> A line starting with # serves as a comment. Put a backslash ("`\`") in
> front of the first hash for patterns that begin with a hash.

I needed to move the comments for Git to parse the file properly. To
maintain readability, I added an extra `#` to the comments at the top of
each section.

[^1]: microsoft@da652d0
[^2]: https://git-scm.com/docs/gitignore/2.43.0#_pattern_format
@loadams loadams enabled auto-merge November 28, 2023 18:28
@loadams loadams added this pull request to the merge queue Nov 28, 2023
Merged via the queue into microsoft:master with commit 3418b86 Nov 28, 2023
15 checks passed
mauryaavinash95 pushed a commit to mauryaavinash95/DeepSpeed that referenced this pull request Feb 17, 2024
The file was re-organized in da652d0[^1] with better documentation, but
that unfortunately made the syntax invalid. According to the gitignore
documentation:[^2]

> A line starting with # serves as a comment. Put a backslash ("`\`") in
> front of the first hash for patterns that begin with a hash.

I needed to move the comments for Git to parse the file properly. To
maintain readability, I added an extra `#` to the comments at the top of
each section.

[^1]:
microsoft@da652d0
[^2]: https://git-scm.com/docs/gitignore/2.43.0#_pattern_format

Co-authored-by: Logan Adams <114770087+loadams@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants