microsoft / microsoft/VFSForGit
Refactor the RelatedWarning/RelatedError interface so that picking the right logging level is more intuitive
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 6.1k
- Forks
- 474
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 8
Description
The "Error" logging level should only be used for events that will result in I/O failures for users. However, there is a tendency for developers to use RelatedError(...) when any unexpected condition occurs (even if there will be no errors noticeable by the user).
See what can be done to make the RelatedWarning/Error more intuitive and reduce the number of false-positive errors that are added to the VFS4G codebase.
See also discussion https://github.com/Microsoft/VFSForGit/pull/879#discussion_r263059474
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the RelatedWarning/RelatedError interface and read the discussion linked from the issue. Determine how the interface can make the intended logging level clearer; done means reducing false-positive Error usage without changing the meaning of user-visible I/O failures.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp
- Domain
- observability, tooling
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100