Add metadata to resources
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 14
- Forks
- 4
- Avg merge
- 3d 21h
- Merged PRs (30d)
- 3
Description
Right now our RemoteResources only track the remoteId of the file in question.
https://github.com/sillsdev/harmony/blob/5a660d125c4f1adc99c3384f275259b3d607d9a1/src/SIL.Harmony/Resource/RemoteResource.cs#L8-L34
we would like to track metadata aswell, this could include stuff like author, copyright etc. For storing the data I think it should be unopinionated and just store a blob of json. We should use either a JsonDocument or JsonNode, I'm not sure which would be ideal, you can read about it here. https://learn.microsoft.com/en-us/dotnet/standard/serialization/system-text-json/use-dom#json-dom-choices
Note that JsonDocument is IDisposable and would need to be disposed when done, that may not be possible to manage.
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 reading src/SIL.Harmony/Resource/RemoteResource.cs at the linked lines to understand the current resource model. Compare JsonDocument and JsonNode using the linked .NET JSON DOM guidance, paying attention to ownership and disposal. Done means RemoteResource can retain unopinionated JSON metadata such as author or copyright without introducing unmanaged lifetime problems.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp
- Domain
- distributed-systems
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100