stride3d / stride3d/stride

Review code annotations

Open
#2,156 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement Epic priority-Low work-estimate-XL
Dominant language
C#
Stars
7.8k
Forks
1.2k
Avg merge
2d 17h
Merged PRs (30d)
49

Description

Following #2155, we use other kind of annotations for instance for serialization.

Some annotations have the same name as ones existing in the .NET standard libraries (such as [DataContract]) which can at least be confusing and at most create mistakes where the wrong one is used.

The purpose of this issue is to list all annotations and review whether the standard ones can be used instead. If so, prepare a deprecation path where at first both can be used and later the custom one is removed.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading issue #2155 and inventorying the project's custom annotations, then compare each with the corresponding .NET standard annotation. Done means the annotations have been reviewed and any suitable replacements have a documented compatibility and deprecation path.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
developer-experience
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.