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
Unclutter the root directory #1249
Comments
Great analysis, @thomaslevesque. All the "sure" stuff sounds good to me. As far as I'm torn on |
Let's leave how_to_build.md where it is then, at least for now. We can revisit later. |
I updated the path to |
👍 |
This change has been released as part of FakeItEasy 4.2.0. |
The root of the repo is currently a bit of a mess. There are 23 files in the root directory, and every new script we add makes it worse (especially for .csx scripts which need a .cmd bootstrapper). We should probably try to move some of these files to a subdirectory.
Files and directories that could be moved to a subdirectory:
build.csx
: the .cmd bootstrapper probably needs to stay at the root, but we can move the actual scriptprepare_release.csx
: same reasoning.githubtoken
*: should probably be next toprepare_release.csx
deploy.ps1
: only called by AppVeyor, we don't need it at the rootpackages.config
andpackages/
*: it's only used by csx scripts (all projects now use the package cache andPackageReference
).nuget/
*: the projects no longer need it, it's only used by scriptsFakeItEasy.Dictionary.xml
,FakeItEasy.ruleset
,FakeItEasy.snk
: referenced fromDirectory.Build.props
, which can specify a subdirectorymkdocs.yml
: according to the documentation, we could move it to thedocs
folderFiles that should stay at the root:
.editorconfig
,.gitignore
,.gitattributes
: apply to the whole repo.mailmap
: Git looks for it at the root of the repoappveyor.yml
: AppVeyor looks for it at the root of the repobuild.cmd
: should be easily accessibleCONTRIBUTING.md
: it's the standard location on GitHubDirectory.Build.props
: applies to projects in all subdirectoriesFakeItEasy.sln
: should be easily accessible, and the root is the only directory that contains all projectsGitVersion.yml
: it has to be in the working directory, which is the root during build. Putting it somewhere else would be awkwardglobal.json
: applies to projects in all subdirectoriesLicence.txt
: it's the standard location on GitHubREADME.md
: standard location on GitHubUnsure:
how_to_build.md
: could probably be in a subdirectory, but it needs to be easy to find. If we move it, we could add a link in the README.prepare_release.cmd
: it's more convenient to have it at the root, but on the other hand, it's only used by the maintainers, and we don't need it very often.(files and folders with a
*
are excluded from source control, so they wouldn't appear in the GitHub repo anyway)The text was updated successfully, but these errors were encountered: