Rename solution, readme and icon files #485
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
These changes are separated from #85, which is becoming too big with the recent refactors. So, I'm extracting some of the changes into separate PRs. |
Nirmal4G
force-pushed
the
repo/rename-files
branch
from
a6244bf to
5ff470b
Compare
|
Updated in response to #486 |
Sergio0694
requested changes
Oct 29, 2022
Nirmal4G
force-pushed
the
repo/rename-files
branch
from
5ff470b to
048e61d
Compare
Nirmal4G
force-pushed
the
repo/rename-files
branch
from
048e61d to
4d0657b
Compare
Nirmal4G
force-pushed
the
repo/rename-files
branch
3 times, most recently
from
9789e27 to
e282adb
Compare
Nirmal4G
force-pushed
the
repo/rename-files
branch
from
e282adb to
267a1c5
Compare
Nirmal4G
force-pushed
the
repo/rename-files
branch
2 times, most recently
from
b42295b to
d86dca8
Compare
New Changes since last ReviewRename
|
Nirmal4G
force-pushed
the
repo/rename-files
branch
2 times, most recently
from
fee6d8a to
4071789
Compare
Nirmal4G
force-pushed
the
repo/rename-files
branch
from
4071789 to
a67224a
Compare
- Rename `build` folder to `eng`:
- This is a standard build infra directory used in official dotnet projects.
- Rename NuGet Icon to `Icon.png`:
- This is no longer used as a public reference point for NuGet icon URL.
- Also, Icon URL is deprecated. Hence, it's safe to change.
- Normalize casing for `ReadMe.md`:
- Repository information files such as ReadMe, License, etc... are only UPPER_CASE
if they are without an extension. With extension, the casing becomes PascalCase
or Kebab-Case. The primary reason is attention to the presentation of file names.
- Do Kebab-Case when a phrase is presented. E.g., `Code-of-Conduct.md`.
- Rename solution file to `CommunityToolkit.sln`:
- The `dotnet` seems implied and also doesn't stand-out in the file list because of the lower casing and `d` char.
- Spaces are a main issue when doing automation (_like using `*.sln` in build scripts and in URLs it adds `%20`_).
- Move `toolkit.snk` file to `eng` sub-directory.
- Remove un-needed and deleted files from solution.
- Update Git Ignore entries to latest from upstream.
- Indent text in `ThirdPartyNotices.txt` with spaces instead.
Nirmal4G
force-pushed
the
repo/rename-files
branch
from
a67224a to
e58781e
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
Rename
buildfolder toeng:engfolder is done early here to get thebuildfolder used for common output paths.Rename NuGet Icon to
Icon.png:Normalize casing for
ReadMe.md:if they are without an extension. With extension, the casing becomes PascalCase
or Kebab-Case. The primary reason is attention to the presentation of file names.
Code-of-Conduct.md.Rename solution file to
CommunityToolkit.sln:dotnetseems implied and also doesn't stand out in the file list because of the lower casing anddchar.*.slnin build scripts and in URLs it adds%20).Misc Changes
toolkit.snkfile tobuildsub-directory.ThirdPartyNotices.txtwith spaces instead.PR Checklist
Other information
Default to pull request title and descriptionin the Repository Pull Request settings to have a better commit message instead ofMerge pull request #xxxx from repo/branchgeneric message.