krestenlaust / krestenlaust/ChessGame
Use nullable reference types or exceptions
Open
Nobody has claimed this yet.
Core (ChessGame)
documentation
- Dominant language
- C#
- Stars
- 5
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
There is a few methods which return null, but this behavior isn't documented. Either they should throw an exception instead, or be documented using nullable annotations.
Contributor guide
No contributing guide indexed for this repository
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
Locate the methods that currently return null and inspect their callers to understand the expected behavior. Decide whether nullable annotations or exceptions are appropriate for each case, then update the affected methods and documentation consistently; done means the null behavior is explicit and no callers rely on an undocumented contract.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp
- Domain
- game-dev
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100