Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Prepare repo for handoff #53

Open
4 of 11 tasks
Willmish opened this issue Mar 14, 2022 · 0 comments
Open
4 of 11 tasks

Prepare repo for handoff #53

Willmish opened this issue Mar 14, 2022 · 0 comments
Assignees
@wheatwolftianchi @Willmish @angela24680403
Labels
documentation Improvements or additions to documentation future extension outside of client requirements Urgent Urgent issue, need to prioritise

Comments

@Willmish
Copy link
Owner

Willmish commented Mar 14, 2022 •
edited
Loading

Before handing off the repo to Avanade, we need to complete the below checklist:

Clean up the code of:

  • magic numbers, (move to config files/Enums)
  • magic texts,
  • comments, TODOs etc (alternatively keep Work-In-Progress files on dev branch or other)

Do:

  • Add documentation for all classes/methods
  • Make sure there are no bugs in RPi Edge program and the desktop GUI program.
  • Make sure the IoT Hub-SQL DB connection will continue working after submission (see if StreamAnalyticsJob IP addresses are part of a resource tag (currently the temporary range added, but this may change))
  • Create a comprehensive README, explaining current state of the system, possibilities for future expansions etc (link to portfolio)
  • Add documentation generation and deployment (will make future development easier!).
  • Centralise tests for subsystems/leave instructions for creating these tests.

Optional (would be nice for future code maintainers):

  • Add clearish instructions for steps necessary for upscaling of the project/continuing the lower scale project (some already in place, see this project and its description for more info.
  • Leave contact details to provide assistance?
@Willmish Willmish added documentation Improvements or additions to documentation Urgent Urgent issue, need to prioritise labels Mar 14, 2022
@Willmish Willmish added this to the Final submission milestone Mar 14, 2022
@Willmish Willmish added the future extension outside of client requirements label Apr 13, 2022
@Willmish Willmish removed this from the Final submission milestone Apr 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@wheatwolftianchi wheatwolftianchi

@Willmish Willmish

@angela24680403 angela24680403

Labels
documentation Improvements or additions to documentation future extension outside of client requirements Urgent Urgent issue, need to prioritise
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@wheatwolftianchi @Willmish @angela24680403