question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Fix warnings and make project consistent

See original GitHub issue

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: https://github.com/GitTools/GitReleaseManager/issues/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: https://github.com/GitTools/GitReleaseManager/issues/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: https://github.com/GitTools/GitReleaseManager/issues/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 https://github.com/GitTools/GitReleaseManager/issues/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.

Issue Analytics

  • State:open
  • Created 3 years ago
  • Comments:8 (8 by maintainers)

github_iconTop GitHub Comments

1reaction
gep13commented, 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.

1reaction
gep13commented, 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

Read more comments on GitHub >

github_iconTop Results From Across the Web

is it best practice to try to remove ALL compiler warnings ...
It can be quite tricky to fix all warnings in a large project. And some compilers have rather obscure sense of "right things...
Read more >
Errors and warnings pane very unreliable.
If I build from within Visual Studio (Micrsoft Visaul Studio Enterprise 2019, Version 16.1.6) its apparently completely random which warnings will show up....
Read more >
Compiler warnings C4000 Through C4199
When you correct issues in your project, always start with the first error or warning ... One fix may make many subsequent errors...
Read more >
Steps I take to fix stubborn TypeScript errors in VS Code
Sometimes fixing a TypeScript or eslint error in VS Code can feel impossible. Here's what I do when I have exhausted all my...
Read more >
Don't just lint your code - fix it with Prettier
Don't abandon your code! Instead, you can review the changes, see if maybe it makes sense to keep it that way (it will...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found