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

Fix warnings and make project consistent #261

Open
6 of 11 tasks
akordowski opened this issue Jul 27, 2020 · 8 comments
Open
6 of 11 tasks

Fix warnings and make project consistent #261

akordowski opened this issue Jul 27, 2020 · 8 comments

Comments

@akordowski
Copy link
Contributor

akordowski commented Jul 27, 2020

Analyzing the repo I've noticed a few things which might be worth to fix.

Make the project consistent with other GitTools projects (e.g. GitVersion)

// <copyright file="file.cs" company="GitTools Contributors">
//     Copyright (c) 2015 - Present - GitTools Contributors
// </copyright>
//-----------------------------------------------------------------------
  • Remove the file header
    Classes in the GitVersion project don't contain any file header. A class rename don't change the filename in the header, which cause a warning and increases the maintenance effort.
  • using definitions above the namespace - covered by this issue: Fully implement editorconfig, stylecop and fxcop analyzers #285
    Visual Studio creates the using definitions above the namespace, so currently new definitions must always manually be placed below the namespace.
  • Consistent folder naming - this is covered by this issue: Make folder naming consistent #276
    The folders in the project should be lowercase
    • Icons -> icons
    • Source -> src
  • Move the file /Documentation/Legal/CREDITS.md to the root folder. - This will be handled here: Update credits.md file #275
    The /Documentation folder is also misleading, because it contains no docs. The project docs are in the docs folder.
  • Unify the config extension - covered by Support both yaml and yml for extension of configuration file #278
    The config for the GitVersion project has the file extension .yml and the GitReleaseManager the extension .yaml. I would suggest to unify this aswell and use the .yml extension. The GRM should then checkt for both extensions.
@akordowski
Copy link
Contributor Author

akordowski commented Jul 27, 2020

I have also a question of understanding. The projects GitReleaseManager.Cli and GitReleaseManager.Tool both create a GitReleaseManager.exe. Through the link of GitReleaseManager.Cli classes the GitReleaseManager.Tool causes warnings because of the inconsistent namespace. What ist the difference between this two projects?

@gep13
Copy link
Member

gep13 commented Jul 27, 2020

@akordowski GitReleaseManager.Cli creates the full .Net Framework version of the application, with the GitReleaseManager.exe, and which is ultimately published to:

https://www.nuget.org/packages/gitreleasemanager
https://chocolatey.org/packages/gitreleasemanager.portable

The GitReleaseManager.Tool creates a .net global tool version of the application, which is ultimately published to here:

https://www.nuget.org/packages/gitreleasemanager.tool

@gep13
Copy link
Member

gep13 commented Jul 27, 2020

@akordowski I will have to go through the list of items above in more detail. Some of them I have no issue with being undertaken, others will need some more thought.

@akordowski
Copy link
Contributor Author

Thanks for the clarification!

@akordowski
Copy link
Contributor Author

Another issue I forgot.

Unify the config extension
The config for the GitVersion project has the file extension .yml and the GitReleaseManager the extension .yaml. I would suggest to unify this aswell and use the .yml extension. The GRM should then checkt for both extensions.

@gep13
Copy link
Member

gep13 commented Aug 24, 2020

Associated issue: #269

@gep13
Copy link
Member

gep13 commented Aug 25, 2020

@akordowski I have been thinking some more about some of the issues that you have raised in this issue. I need to think about them some more, and I will update this issue with some thoughts once I have put them all together.

@akordowski
Copy link
Contributor Author

@gep13 Alright. Take your time.

This was referenced Mar 6, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants