Skip to content

Commit

Permalink
Rename solution, readme and icon files
Browse files Browse the repository at this point in the history
- 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.
  • Loading branch information
Nirmal4G committed Jan 14, 2023
1 parent 399bf42 commit a67224a
Show file tree
Hide file tree
Showing 14 changed files with 27 additions and 28 deletions.
18 changes: 11 additions & 7 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,21 @@
# Visual Studio 15+ auto generated files
Generated\ Files/

# Backup folder for Package Reference Convert tool in Visual Studio 15+
MigrationBackup/

# Live Unit Testing for Visual Studio
.lutignore
*.lutconfig

# Local History for Visual Studio
.localhistory/

# Visual Studio History (VSHistory) files
.vshistory/

# Backup folder for Package Reference Convert tool in Visual Studio 2017
MigrationBackup/
# Local History for Visual Studio Code
.history/

# VS Code files for those working on multiple tools
.vscode/*
Expand All @@ -45,9 +52,6 @@ MigrationBackup/
!.vscode/extensions.json
*.code-workspace

# Local History for Visual Studio Code
.history/

# MSTest test Results
[Tt]est[Rr]esult*/
[Bb]uild[Ll]og.*
Expand Down Expand Up @@ -95,7 +99,7 @@ StyleCopReport.xml
*.tlog
*.vspscc
*.vssscc
.builds
*.builds
*.pidb
*.svclog
*.scc
Expand Down Expand Up @@ -177,7 +181,7 @@ _pkginfo.txt

# Others
ClientBin/
~$*
~*
*~
*~.*
*.dbmdl
Expand Down
File renamed without changes.
16 changes: 6 additions & 10 deletions dotnet Community Toolkit.sln → CommunityToolkit.sln
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
azure-pipelines.yml = azure-pipelines.yml
Directory.Build.props = Directory.Build.props
Directory.Build.targets = Directory.Build.targets
toolkit.snk = toolkit.snk
version.json = version.json
EndProjectSection
EndProject
Expand All @@ -27,10 +26,10 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "CommunityToolkit.HighPerfor
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Docs", "Docs", "{88C6FFBE-322D-4CEA-842B-B2CB281D357D}"
ProjectSection(SolutionItems) = preProject
CODE_OF_CONDUCT.md = CODE_OF_CONDUCT.md
Code-of-Conduct.md = Code-of-Conduct.md
Contributing.md = Contributing.md
License.md = License.md
README.md = README.md
ReadMe.md = ReadMe.md
ThirdPartyNotices.txt = ThirdPartyNotices.txt
EndProjectSection
EndProject
Expand All @@ -44,13 +43,10 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "CommunityToolkit.Common.Uni
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Build", "Build", "{CD16E790-7B7B-411E-9CE7-768E759CC22D}"
ProjectSection(SolutionItems) = preProject
build\Community.Toolkit.Common.props = build\Community.Toolkit.Common.props
build\Community.Toolkit.Common.targets = build\Community.Toolkit.Common.targets
build\header.txt = build\header.txt
build\nuget.png = build\nuget.png
build\Sign-Package.ps1 = build\Sign-Package.ps1
build\SignClientSettings.json = build\SignClientSettings.json
build\Update-Headers.ps1 = build\Update-Headers.ps1
eng\Toolkit.Common.props = eng\Toolkit.Common.props
eng\Toolkit.Common.targets = eng\Toolkit.Common.targets
eng\Sign-Package.ps1 = eng\Sign-Package.ps1
eng\SignClientSettings.json = eng\SignClientSettings.json
EndProjectSection
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Configuration", "Configuration", "{6640D447-C28D-4DBB-91F4-3ADCE0CA64AD}"
Expand Down
4 changes: 2 additions & 2 deletions Directory.Build.props
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

<PropertyGroup>
<RepositoryDirectory>$(MSBuildThisFileDirectory)</RepositoryDirectory>
<BuildToolsDirectory>$(RepositoryDirectory)build\</BuildToolsDirectory>
<BuildToolsDirectory>$(RepositoryDirectory)eng\</BuildToolsDirectory>
</PropertyGroup>

<Import Project="$(BuildToolsDirectory)Community.Toolkit.Common.props" />
<Import Project="$(BuildToolsDirectory)Toolkit.Common.props" />

<Choose>
<When Condition="$(IsCoreProject)">
Expand Down
2 changes: 1 addition & 1 deletion Directory.Build.targets
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<Project>

<Import Project="$(BuildToolsDirectory)Community.Toolkit.Common.targets" />
<Import Project="$(BuildToolsDirectory)Toolkit.Common.targets" />

<Target Name="AddCommitHashToAssemblyAttributes" BeforeTargets="GetAssemblyAttributes">
<ItemGroup>
Expand Down
2 changes: 1 addition & 1 deletion README.md → ReadMe.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Check out our [Preview Packages Wiki Page](https://github.com/CommunityToolkit/d
## 📄 Code of Conduct

This project has adopted the code of conduct defined by the [Contributor Covenant](http://contributor-covenant.org/) to clarify expected behavior in our community.
For more information see the [.NET Foundation Code of Conduct](CODE_OF_CONDUCT.md).
For more information see the [.NET Foundation's Code of Conduct](Code-of-Conduct.md).

## 🏢 .NET Foundation

Expand Down
6 changes: 3 additions & 3 deletions ThirdPartyNotices.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ Do Not Translate or Localize

This project incorporates components from the projects listed below. The original copyright notices and the licenses under which the .NET Foundation received such components are set forth below. The .NET Foundation reserves all rights not expressly granted herein, whether by implication, estoppel or otherwise.

1. PedroLamas/DeferredEvents version 1.0.4 (https://github.com/PedroLamas/DeferredEvents), included in CommunityToolkit.Common/Deferred.
2. MichaeIDietrich/UwpNotificationNetCoreTest commit 5c1a4a3 (https://github.com/MichaeIDietrich/UwpNotificationNetCoreTest), used in DesktopNotificationManagerCompat.cs to support .NET Core 3.0.
3. lbugnion/mvvmlight commit 4cbf77c (https://github.com/lbugnion/mvvmlight), from which some APIs from the `CommunityToolkit.Mvvm` package take inspiration from.
1. PedroLamas/DeferredEvents version 1.0.4 (https://github.com/PedroLamas/DeferredEvents), included in CommunityToolkit.Common/Deferred.
2. MichaeIDietrich/UwpNotificationNetCoreTest commit 5c1a4a3 (https://github.com/MichaeIDietrich/UwpNotificationNetCoreTest), used in DesktopNotificationManagerCompat.cs to support .NET Core 3.0.
3. lbugnion/mvvmlight commit 4cbf77c (https://github.com/lbugnion/mvvmlight), from which some APIs from the `CommunityToolkit.Mvvm` package take inspiration from.
4. PrivateObject/PrivateType (https://github.com/microsoft/testfx/tree/664ac7c2ac9dbfbee9d2a0ef560cfd72449dfe34/src/TestFramework/Extension.Desktop), included in UnitTests.
5. QuinnDamerell/UniversalMarkdown (https://github.com/QuinnDamerell/UniversalMarkdown) contributed by Quinn Damerell and Paul Bartrum for the MarkdownTextBlock control, relicensed to this .NET Foundation project under the MIT license upon contribution in https://github.com/CommunityToolkit/WindowsCommunityToolkit/pull/772.
6. qmatteoq/DesktopBridgeHelpers commit e278153 (https://github.com/qmatteoq/DesktopBridgeHelpers), contributed by Matteo Pagani to identify if running with identity in DesktopNotificationManagerCompat.cs and DesktopBridgeHelpers.cs, relicensed to this .NET Foundation project under the MIT license upon contribution in https://github.com/CommunityToolkit/WindowsCommunityToolkit/pull/3457.
Expand Down
2 changes: 1 addition & 1 deletion azure-pipelines.yml
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ jobs:
displayName: Pack solution

# Sign packages
- pwsh: build/Sign-Package.ps1
- pwsh: eng/Sign-Package.ps1
displayName: Authenticode sign packages
env:
SignClientUser: $(SignClientUser)
Expand Down
File renamed without changes
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@
<PackageProjectUrl>https://github.com/CommunityToolkit/dotnet</PackageProjectUrl>
<PackageReleaseNotes>https://github.com/CommunityToolkit/dotnet/releases</PackageReleaseNotes>
<PackageIcon>Icon.png</PackageIcon>
<PackageIconUrl>https://raw.githubusercontent.com/CommunityToolkit/dotnet/main/build/nuget.png</PackageIconUrl>
</PropertyGroup>

<PropertyGroup>
Expand All @@ -33,7 +32,7 @@

<PropertyGroup>
<SignAssembly>true</SignAssembly>
<AssemblyOriginatorKeyFile>$(RepositoryDirectory)toolkit.snk</AssemblyOriginatorKeyFile>
<AssemblyOriginatorKeyFile>$(MSBuildThisFileDirectory)toolkit.snk</AssemblyOriginatorKeyFile>
<AssemblySignPublicKey>002400000480000094000000060200000024000052534131000400000100010041753AF735AE6140C9508567666C51C6AB929806ADB0D210694B30AB142A060237BC741F9682E7D8D4310364B4BBA4EE89CC9D3D5CE7E5583587E8EA44DCA09977996582875E71FB54FA7B170798D853D5D8010B07219633BDB761D01AC924DA44576D6180CDCEAE537973982BB461C541541D58417A3794E34F45E6F2D129E2</AssemblySignPublicKey>
</PropertyGroup>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
</PropertyGroup>

<ItemGroup Condition="$(IsPackable)">
<None Include="$(BuildToolsDirectory)nuget.png" Pack="true" PackagePath="\Icon.png" Visible="False" />
<None Include="$(BuildToolsDirectory)Icon.png" Pack="true" PackagePath="\" Visible="False" />
<None Include="$(RepositoryDirectory)License.md" Pack="true" PackagePath="\" Visible="False" />
<None Include="$(RepositoryDirectory)ThirdPartyNotices.txt" Pack="true" PackagePath="\" Visible="False" />
</ItemGroup>
Expand Down
File renamed without changes.

0 comments on commit a67224a

Please sign in to comment.