microsoft / microsoft/OSSGadget
APIs which return a version should return a parsed version object
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 371
- Forks
- 58
- PR merge metrics
- No merged PRs in 30d
Description
OSSGadget should have a version object for use in APIs that return version information.
Initial ideas:
Model the object on semver - ability to grab specific pieces of version?
For APIs like GetLatestVersion should we return a single version object which contains both the latest release and the latest pre-release?
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
Start by reviewing the existing APIs that return version information, especially GetLatestVersion, and document their current return shapes. Clarify whether the parsed object should expose specific version parts and how latest release and pre-release values should be represented. Done means the API design is agreed and all relevant version-returning APIs consistently use the defined object.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp
- Domain
- api
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100