diff --git a/README.md b/README.md index 4a006a5..d2843ff 100644 --- a/README.md +++ b/README.md @@ -1 +1,17 @@ # Team047-T47 + +This is a template for CS411 project repository. Please make sure that your title follows the convention: [TeamID]-[YourTeamName]. All TeamID should have a three digit coding (i.e. if you are team 20, you should have `team020` as your ID.). You should also make sure that your url for this repository is [fa23-cs411-team000-teamname.git] so TAs can correctly clone your repository and keep them up-to-date. + +Once you setup your project, please remember to submit your team formation to the team form. + +## Permission +You should make sure you allow TAs to access your repository. You can add TA(s) as a collaborator to your repository. + +## Preparing for your release +Eash submission should be in it's own [release](https://docs.github.com/en/repositories/releasing-projects-on-github/about-releases). Release are specific freezes to your repository. You should submit your commit hash on canvas or google sheet. When tagging your stage, please use the tag `stage.x` where x is the number to represent the stage. + +## Keeping things up-to-date +You should make sure you keep your project root files up-to-date. Information for each file/folders are explained. + +## Code Contribution +Individual code contribution will be used to evaluate individual contribution to the project.