Skip to content

Commit 8966e2f

Browse files
committed
Warn Windows users of use of symlinks in repository
1 parent 47d33b1 commit 8966e2f

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,6 @@ you. Once you have tested and confirmed that the issue is resolved, close the
113113
issue. If you are not a member of the project, you will be asked for
114114
confirmation and we will close it.
115115

116-
117116
## Documentation
118117

119118
The files which make up Stack's documentation are located in the `doc`
@@ -142,11 +141,20 @@ released.
142141
The Markdown syntax supported by MkDocs can differ from the GitHub Flavored
143142
Markdown ([GFM](https://github.github.com/gfm/)) supported for content on
144143
GitHub.com. Please refer to the
145-
[MkDocs documentation](https://www.mkdocs.org/user-guide/writing-your-docs/#writing-with-markdown)
144+
[MkDocs documentation](https://www.mkdocs.org/user-guide/writing-your-docs/#writing-with-markdown)
146145
to ensure your pull request will achieve the desired rendering.
147146

148147
The configuration file for MkDocs is `mkdocs.yml`.
149148

149+
The files in the `doc` directory of the repository include two symbolic links
150+
(symlinks), `ChangeLog.md` and `CONTRIBUTING.md`. Users of Git on Windows should
151+
be aware of its approach to symbolic links. See the
152+
[Git for Windows Wiki](https://github.com/git-for-windows/git/wiki/Symbolic-Links).
153+
If `git config --show-scope --show-origin core.symlinks` is `false` in a local
154+
repository on Windows, then the files will be checked out as small plain files
155+
that contain the link text See the
156+
[Git documentation](https://git-scm.com/docs/git-config#Documentation/git-config.txt-coresymlinks).
157+
150158
## Code
151159

152160
If you would like to contribute code to fix a bug, add a new feature, or

0 commit comments

Comments
 (0)