Skip to content

Rename solution, readme and icon files#485

Open
Nirmal4G wants to merge 1 commit intoCommunityToolkit:mainfrom
Nirmal4G:repo/rename-files
Open

Rename solution, readme and icon files#485
Nirmal4G wants to merge 1 commit intoCommunityToolkit:mainfrom
Nirmal4G:repo/rename-files

Conversation

@Nirmal4G
Copy link
Contributor

@Nirmal4G Nirmal4G commented Oct 27, 2022

Changes

Rename build folder to eng:

  • This is a standard build infra directory used in official dotnet projects.
  • Rename to eng folder is done early here to get the build folder used for common output paths.

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).

Misc Changes

  • Move toolkit.snk file to build sub-directory.
  • Remove un-needed and deleted files from solution.
  • Update Git Ignore entries to latest from upstream.
  • Rename MSBuild props and targets to shorter names.
  • Indent text in ThirdPartyNotices.txt with spaces instead.

PR Checklist

  • Created a separate branch (other than main/master) in your fork
  • Based off latest main branch of toolkit
  • Pull Request doesn't include merge commits
  • Header has been added to all new source files
  • Contains NO breaking changes
  • Code follows all style conventions

Other information

  • Please Rebase merge if possible.
  • Please update the default message option to Default to pull request title and description in the Repository Pull Request settings to have a better commit message instead of Merge pull request #xxxx from repo/branch generic message.
@Nirmal4G
Copy link
Contributor Author

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
Copy link
Contributor Author

Updated in response to #486

@Nirmal4G Nirmal4G requested a review from Sergio0694 November 16, 2022 12:48
@Nirmal4G Nirmal4G force-pushed the repo/rename-files branch 3 times, most recently from 9789e27 to e282adb Compare November 24, 2022 07:10
@Nirmal4G
Copy link
Contributor Author

Updated in response to #507 and #510

@Nirmal4G Nirmal4G force-pushed the repo/rename-files branch 2 times, most recently from b42295b to d86dca8 Compare January 13, 2023 05:04
@Nirmal4G
Copy link
Contributor Author

Nirmal4G commented Jan 13, 2023

New Changes since last Review

Rename build folder to eng:

  • This is a standard build infra directory used in official dotnet projects.
  • Rename to eng folder is done early here to get the build folder used for common output paths.

Misc Changes

  • Rename MSBuild props and targets to shorter names.

This change is extracted early from patch #96. That PR itself is not yet updated as it depends on changes from this patch and patch #85.

@Nirmal4G Nirmal4G force-pushed the repo/rename-files branch 2 times, most recently from fee6d8a to 4071789 Compare January 13, 2023 14:56
@Nirmal4G Nirmal4G marked this pull request as draft January 14, 2023 05:22
@Nirmal4G Nirmal4G marked this pull request as ready for review January 14, 2023 05:38
- 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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

2 participants