search

microsoft / Extensible-Digital-Content

This template is a media viewer that enables a user to interact and view media files on both Xbox console and Desktop.
MIT License
6 stars 2 forks source link

Migrated all work from atg EDC incubation to this github repo. This is V1 #1

Closed andrewbanks17 closed 7 months ago

andrewbanks17 commented 8 months ago

The initial code from the incubation.

This PR was made by copy pasting what was in the incubation.

However, in order to make this PR, I had to activate Just in Time administrator access through windows open source in order for me to make this PR from my personal account. I currently cannot access this pr from my corp account or my EMU account. I don't have a github with my corp account(non emu) to my understanding.

I am not sure if this is best practice or not.

This is just the v1 of the sample, its still missing a few things such as AUDIO FILES, and the support.md doc will eventually be updated.

Andrew-Farrier commented 8 months ago

One comment that applies to all the files. There should be heavy commenting in the code around why/how each of the components work. Also as part of that commenting should be heavy documentation on the common scenarios and exactly where they would make changes to support those scenarios.

Andrew-Farrier commented 8 months ago

A step-by-step guide should be created for how the user customizes everything for their content. Think the end user of that step-by-step guide is a non-engineer that most likely wouldn't even look at the code beyond some config files.

Andrew-Farrier commented 8 months ago

In terms of comments it might be useful to point out directed places to make changes for specific changes that we think a developer may want to make beyond the base functionality. Something like "Change this value to X to adjust behavior to be Y".

Maybe include some kind of keyword in all those comments so a developer can quickly find all the proper locations to make those changes. They could also be included in the step-by-step guide or maybe a second document that contains "easy" further changes they could do to customize behavior beyond just dropping some content in the correct folders.

andrewbanks17 commented 8 months ago

Ok, I have added a step by step guide to the readme, and also rearranged the comments in the datamodel.cs to make it more clear on how to modify the application.