Skip to content

refactor: overhead files #26

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

Merged
merged 4 commits into from
Apr 13, 2025
Merged

refactor: overhead files #26

merged 4 commits into from
Apr 13, 2025

Conversation

BenjaminAbt
Copy link
Owner

This pull request makes significant updates to the .editorconfig file and modifies the CI workflow configuration in .github/workflows/ci.yml. The key changes include enhancing coding standards and simplifying the CI process by leveraging a reusable workflow.

Updates to .editorconfig:

  • Added detailed configuration for various file types, including Markdown, Bicep, XML, TypeScript, JavaScript, HTML, CSS/SCSS, YAML, JSON, PowerShell, and Shell. This includes settings for indent_size, max_line_length, and other formatting rules.
  • Introduced several new coding conventions and style rules for C# and .NET, such as preferences for parentheses, modifier usage, and expression-level preferences. [1] [2] [3] [4] [5]
  • Added diagnostic severity levels for various CA, IDE, Roslyn, and Meziantou.Analyzer rules to enforce or relax specific coding practices.

Changes to CI workflow:

  • Replaced the detailed CI job configuration with a reusable workflow from mycsharp/github-actions/.github/workflows/dotnet-nuget-build-multi-sdk.yml, simplifying the setup and maintenance of the CI process.
  • Updated the workflow to trigger on release events and specified multiple .NET SDK versions for compatibility testing.

Changed test namespaces from `StrongOf.Tests` to `StrongOf.UnitTests` for better organization. Added a copyright header to the `.editorconfig` file. Simplified assertions in `StrongDateTimeOffset_Operators_Tests` by removing unnecessary parentheses. These changes were applied consistently across multiple test files to enhance readability and maintainability.
This commit introduces copyright comments to various source files, indicating that the code is copyrighted by Benjamin Abt. The `.editorconfig` file has been updated to change the `indent_size` from 4 to 2 and to include a new `file_header_template` for the copyright notice. Additionally, several files had their `using` directives reordered or modified, and some missing `using` directives were added to ensure proper namespace usage. These changes improve the documentation and formatting consistency across the codebase.
Removed specific <PropertyGroup> sections from
`StrongOf.AspNetCore.csproj`, `StrongOf.FluentValidation.csproj`,
`StrongOf.Json.csproj`, and `StrongOf.csproj`. This includes
deleting the <AssemblyName> elements and associated package
metadata, indicating a potential restructuring of the
project organization and build process.
@BenjaminAbt BenjaminAbt merged commit a7acc91 into main Apr 13, 2025
2 checks passed
@BenjaminAbt BenjaminAbt deleted the feature/overhead-files branch April 13, 2025 11:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant