Repo Cleanup - Githubissues

nsyousef commented 1 year ago

We should make sure our repo is cleaned up and prepared for submission. Some of the tasks we need to do are:

[x] delete any unused files from the repo
[x] have documentation explaining to Malcom (or whichever TA grades this) how to use our CI/CD build pipeline and how to generate release notes
[ ] perhaps have documents explaining our branching strategy
[ ] any other instructions we need to give Malcom so he can understand how we did things
[x] Update file tree structure in README.md in main (it does not auto-update and was generated a while ago (unless anyone updated it that I am not aware of)

If you all can think of anything else we need to do to clean up the repo, feel free to add it to this issue as well. I don't know if we will need to have this done by Sunday, or if we just need the coding done by Sunday and can do this during finals week. If someone knows, could you please clarify? Thanks!

phuanh004 commented 1 year ago

Solid task post Nick!

As I remember we can fix the document later than Sunday. But the code part which in the source folder must be freeze on Sunday

henryzhang03 commented 1 year ago

@nsyousef @phuanh004 just did some cleanup and updated the tree. Regarding the other documentation, I can write that later tonight.

henryzhang03 commented 1 year ago

@nsyousef are you able to help write the CI/CD pipeline doc and the release notes one as well?

nsyousef commented 1 year ago

Sure. I can write those.

nsyousef commented 1 year ago

The CI/CD Pipeline and Release Notes Generator docs have been created. If you have time, please review them to make sure everything is clear. The CI/CD pipeline docs can be found in admin/cipipeline and the release notes generator docs can be found in admin/releasenotesgenerator.

phuanh004 commented 1 year ago

Hmm, got some CI error with the latest commit

nsyousef commented 1 year ago

Yeah. I saw those too. I think one of the E2E tests is timing out, but not really sure why. Not sure if we should change it at this point because of the code freeze or if we should just let it be.

henryzhang03 commented 1 year ago

It's not too big of a deal, change if you want. Its just Github's machines being slow lol. You just need to increase the timeout. @phuanh004 @nsyousef

phuanh004 commented 1 year ago

It looks good to me.

On Wed, Jun 14, 2023 at 11:24 PM Henry Zhang @.***> wrote:

It's not too big of a deal, change if you want. Its just Github's machines being slow lol. You just need to increase the timeout. @phuanh004 https://github.com/phuanh004 @nsyousef https://github.com/nsyousef

— Reply to this email directly, view it on GitHub https://github.com/cse110-sp23-group3/cse110-sp23-group3/issues/84#issuecomment-1592438749, or unsubscribe https://github.com/notifications/unsubscribe-auth/ACGEF6BMSNB37IYPIIMT2STXLKTCPANCNFSM6AAAAAAZAJILQ4 . You are receiving this because you were mentioned.Message ID: @.***>

cse110-sp23-group3 / cse110-sp23-group3

Repo Cleanup #84