{"type":"doc","content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"53647cb6-6e41-4a7e-838b-a9cf572e6a12"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"8e2d87d8-4ef3-48f9-ab0b-12c2924842af"}},{"type":"heading","attrs":{"level":1},"content":[{"text":"Meetings","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Weekly Meetings","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"In each week we will alternate between online meetings and offline dev sessions","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Online meetings will be held on Discord and will be quite structured - give updates, address anything that needs to be discussed as a team","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Offline dev sessions will be held on campus and are a great opportunity to hang out with the team and work on the project together - snacks will be provided :))","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"What days and the pattern of which weeks are online/offline are still TBD","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Asynchronous Standups","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"You should also be posting a standup in the ","type":"text"},{"text":"#standups","type":"text","marks":[{"type":"code"}]},{"text":" channel on Discord each week so that the team and execs can get an idea of what’s going on with the project","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The format for these is:","type":"text"}]}]}]},{"type":"codeBlock","content":[{"text":"What you did\nWhat you will do\nAny problems you need help with","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Tools","type":"text"}]},{"type":"paragraph","content":[{"text":"If you have trouble accessing any of these let us know :)","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Confluence","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Where this page is!","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"We will have our meeting minutes in our Confluence space ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"This space also contains some important information about the Project","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"You can freely view and edit these pages ","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Jira","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"This is where you can find all the tasks that need to be completed and where your tasks will be assigned","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"There is a shortcut from the Confluence page ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Can also access from here: ","type":"text"},{"text":"https://compclub.atlassian.net/jira/software/projects/FREE/boards/6","type":"text","marks":[{"type":"link","attrs":{"href":"https://compclub.atlassian.net/jira/software/projects/FREE/boards/6"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Sprints are comprised of ","type":"text"},{"text":"Tasks","type":"text","marks":[{"type":"strong"}]},{"text":", which represent smaller distinct tasks to be complete as we progress towards completing the sprint","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Typically assigned to 1 or 2 ppl","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"e.g. ‘Create home page’","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Tasks may have ","type":"text"},{"text":"Subtasks","type":"text","marks":[{"type":"strong"}]},{"text":" - these can be helpful if multiple are people assigned to a Task and you need to divide the work somehow","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Each issue has a status, these are: ","type":"text"},{"type":"status","attrs":{"color":"neutral","style":"bold","text":"TO DO","localId":"2c3a7850-d906-48de-bfa3-92f66b9b199b"}},{"text":", ","type":"text"},{"type":"status","attrs":{"color":"blue","style":"bold","text":"IN PROGRESS","localId":"c186de72-e77c-4f16-aa22-a643d2a0dc5b"}},{"text":", ","type":"text"},{"type":"status","attrs":{"color":"blue","style":"bold","text":"PENDING REView","localId":"d7550aa6-fcdb-46ac-8579-5ac9341dbaad"}},{"text":" and ","type":"text"},{"type":"status","attrs":{"color":"green","style":"bold","text":"DONE","localId":"5f3b437b-0484-4d55-80b5-6b80283a910e"}},{"text":" ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Jira can automatically move tickets to ","type":"text"},{"type":"status","attrs":{"color":"blue","style":"bold","text":"IN progress","localId":"160a4e07-74f2-4718-86de-54920ab6f3a6"}},{"text":" when you create a branch, then to ","type":"text"},{"type":"status","attrs":{"color":"blue","style":"bold","text":"PENDING REVIEW","localId":"b621a1da-1534-49a7-bc68-c833cb1160db"}},{"text":" when you open a PR and finally ","type":"text"},{"type":"status","attrs":{"color":"green","style":"bold","text":"done","localId":"732915c8-efa4-4d44-9ebe-1e32933f77f2"}},{"text":" when the PR is merged","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If the issue is not code related (e.g. design something) then you need to make sure to manually move them","type":"text"}]}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"GitHub","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The Freerooms GitHub repository is here: ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://github.com/csesoc/Freerooms"}}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"master","type":"text","marks":[{"type":"code"}]},{"text":" branch contains our most final code","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"For any fix/feature you need to implement, create a separate branch","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If the feature has a corresponding Jira ticket, make sure to name it accordingly! (see below)","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Commit and push OFTEN !!!","type":"text","marks":[{"type":"strong"}]},{"text":" Please don’t wait till your whole task is complete to commit and/or push, commit for every small milestone (even if it doesn’t really work)","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"For your commit messages, you are mostly free to do what you want (just please, no one-word commit messages like “update”, they are so hard to read XD) - be descriptive! ","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Don’t push directly to master!","type":"text","marks":[{"type":"strong"}]},{"text":" When you are happy with your branch, open a pull request and assign reviewers (one of the directors, and one team member)","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Make sure to comment your code to make your reviewer’s life easier","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If you a reviewer: take the time to review carefully ","type":"text"},{"type":"emoji","attrs":{"id":"1f603","text":"😃","shortName":":smiley:"}},{"text":" they are very important! If you see any improvements that can be made, can add a comment on the PR","type":"text"}]}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Branch Naming Conventions","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The format for branches is ","type":"text"},{"text":"-","type":"text","marks":[{"type":"code"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]},{"text":": Optional. If there is a corresponding Jira ticket, put the ticket number at the front.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]},{"text":": Briefly describe what the branch is for","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Examples: ","type":"text"},{"text":"FREE-23-landing-page","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"FREE-51-filter-function","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"map-fixes","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Pull Request/Merge Commit Naming Conventions","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The format for pull request names is ","type":"text"},{"text":"(): ","type":"text","marks":[{"type":"code"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]},{"text":": The type of pull request. Examples include:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"feat","type":"text","marks":[{"type":"code"}]},{"text":" - new feature","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"fix","type":"text","marks":[{"type":"code"}]},{"text":" - bug fix","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"docs","type":"text","marks":[{"type":"code"}]},{"text":" - changes to the documentation","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"style","type":"text","marks":[{"type":"code"}]},{"text":" - formatting, missing semi colons, etc. (no code change)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"refactor","type":"text","marks":[{"type":"code"}]},{"text":" - refactoring code (changing code but not changing what it does) e.g. extracting duplicate code into a helper function","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"test","type":"text","marks":[{"type":"code"}]},{"text":" - adding tests, refactoring tests","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"chore","type":"text","marks":[{"type":"code"}]},{"text":" - anything else e.g. updating the Dockerfile or other config files","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]},{"text":": Optional. The scope (e.g. the feature) that this pull request changes","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]},{"text":": Briefly describe the changes made in the PR in future tense","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Examples: ","type":"text"},{"text":"feat(map): dynamically load building markers","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"fix(scraper): prevent scraping on every deploy","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"chore(deps): update node.js to v19","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Discord","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"This is where we will hold our online meetings","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Important announcements and info about bonding events will be posted in the Freerooms ","type":"text"},{"text":"#announcements","type":"text","marks":[{"type":"code"}]},{"text":" channel","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Discuss anything Freerooms related in the ","type":"text"},{"text":"#general","type":"text","marks":[{"type":"code"}]},{"text":" channel :))","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Try to use the Discord channel/make a thread when you need to discuss smth with ur partner for ur ticket","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"#technical","type":"text","marks":[{"type":"code"}]},{"text":" channel is for anything concerning deployment - if you want the Platform team to see smth post it here","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"#jira","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"#github","type":"text","marks":[{"type":"code"}]},{"text":" channels post any updates forwarded from Jira and GitHub","type":"text"}]}]}]}],"version":1}

Browser not supported