Skip to content
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

Codebase Refactoring for Consistent Style #572

Merged
merged 10 commits into from
Dec 31, 2023
Merged

Codebase Refactoring for Consistent Style #572

merged 10 commits into from
Dec 31, 2023

Conversation

Bram1903
Copy link
Collaborator

@Bram1903 Bram1903 commented Dec 19, 2023

Description

This pull request addresses the need for a uniform and consistent coding style throughout the project. After a thorough review, it became apparent that the codebase had various inconsistent coding style behaviors, incorrect indenting, and discrepancies in space and white line usage. To enhance readability, maintainability, and collaboration, I have undertaken a comprehensive reformatting of the entire project.

Changes Made

  • Standardized coding style across the entire codebase
  • Corrected indentation for improved code structure
  • Ensured consistent usage of spaces and lines throughout the project
  • Addressed any other identified issues related to coding style discrepancies

Benefits

  • Improved readability and maintainability
  • Enhanced collaboration by establishing a consistent coding style
  • Reduced likelihood of errors and confusion

Testing

I have tested the refactored code extensively to ensure that the changes do not introduce any functional alterations. All existing functionality should remain intact.

Notes for Reviewers

Please review the changes to ensure that the coding style adjustments align with best practices and project conventions. Feel free to comment if you have any concerns or suggestions, and I will address them as soon as possible.

PS. You may check out the Code-Reformat branch to check out the changes I made, so you get a feeling of how much more consistent the entire code base became.

Kind regards,
Bram

A simple change has been made to correct a minor grammatical mistake in the UserLoginState.razor file within Components/Identity.
@Bram1903 Bram1903 added the Enhancement New feature or request label Dec 19, 2023
@Bram1903 Bram1903 requested a review from neozhu December 19, 2023 11:26
@Bram1903 Bram1903 self-assigned this Dec 19, 2023
# Conflicts:
#	src/Server.UI/Components/Routes.razor
This commit includes minor formatting changes across several files to improve the readability of the code and adhere to standard coding practices. Changes include code arrangement, the handling of newlines at EOF, and adjusting certain tags for visual consistency.
# Conflicts:
#	src/Application/Application.csproj
#	src/Infrastructure/Infrastructure.csproj
#	src/Server.UI/Server.UI.csproj
#	src/Server/Server.csproj
#	tests/Application.IntegrationTests/Application.IntegrationTests.csproj
#	tests/Application.UnitTests/Application.UnitTests.csproj
#	tests/Domain.UnitTests/Domain.UnitTests.csproj
@Bram1903
Copy link
Collaborator Author

@neozhu could you review this PR?

@neozhu
Copy link
Owner

neozhu commented Dec 30, 2023

@neozhu could you review this PR?

Happy New Year, Bram1903!

I've reviewed the PR you mentioned. Most of the issues I noticed pertain to formatting inconsistencies. I suggest using an .editorconfig file to effectively unify code formatting across different developers. This tool is quite helpful in maintaining consistent coding styles for multiple developers working on the same project across various editors and IDEs.

However, if we don't have an .editorconfig file, what other methods would you suggest for standardizing code formatting?

@Bram1903
Copy link
Collaborator Author

Early happy new year to you as well @neozhu!

About the .editorconfig, yes you are correct. We should in fact use an .editorconfig, however the last/current one is really bad. I will be home tomorrow, and create one for this project. I already have something in mind. I'll push the new editorconfig file tomorrow, so we'll just keep this PR open for now!

Happy new year,
Bram

@Bram1903
Copy link
Collaborator Author

@neozhu, I updated the .editorconfig file, which should be a huge improvement over the last one!

@neozhu neozhu merged commit a2799e2 into main Dec 31, 2023
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants