tP: Plan v1.0 [week 7]

Organization Setup

Please follow the organization/repo name format precisely because we use scripts to download your code or else our scripts will not be able to detect your work.

After receiving your team ID, one team member should do the following steps:

• Create a GitHub organization with the following details:
  • Organization name (all UPPER CASE) : AY1920S2-TEAM_ID. e.g.  AY1920S2-CS2113T-W12-1, AY1920S2-CS2113-F09-3
  • Plan:  Open Source ($0/month)
  • This organization belongs to: My personal account
• Add members to the organization:
  • Create a team called developers to your organization.
  • Add your team members to the developers team.

Repo Setup

The tP project template given to you is a variation of the Duke repo you used for the iP, but with some important differences. Please follow instructions carefully, rather than follow what you remember from the iP.

Only one team member:

1. Fork the tP project template nus-cs2113-AY1920S2/tP repo to your team org.
   This repo (let's call it the team repo) is to be used as the repo for your project.
   Please do not rename the fork Reason: it will make it difficult for our bots to find your fork if you rename it.
2. Enable the issue tracker of the team repo Reason: our bots will be posting your weekly progress reports on the issue tracker of your team repo.
3. Enable GitHub actions: Go to the Actions tab and enable workflows by clicking the I understand my workflows ... button. That will enable the GitHub Actions that come with the project template.
4. Enable GitHub Pages: Go to the Settings tab and enable GitHub Pages for the master branch /docs folder (similar to how you did it in the iP).
   Remember to choose a theme too by clicking the Choose a theme button (that will create a commit in your repo that is needed in a later step.
   After a few minutes, confirm your tP website is available in the corresponding github.io URL.
5. Give access to team members: Ensure your team members have the desired level of access to your team repo.
6. Create a team PR for us to track your project progress: i.e., create a PR from your team repo master branch to [nus-cs2113-AY1920S2/tP] master branch. PR name: [Team ID] Product Name e.g., [CS2113T-T09-2] Contact List Pro. As you merge code to your team repo's master branch, this PR will auto-update to reflect how much your team's product has progressed. In the PR description use @githubUserName@mention the other team members so that they get notified when the tutor adds comments to the PR.

All team members:

1. Watch the tP repo (created above) i.e., go to the repo and click on the Watch button to subscribe to activities of the repo
2. Fork the tP repo to your personal GitHub account.
   Please do not rename the fork Reason: it will make it difficult for our bots to find your fork if you rename it.
3. Clone the fork to your computer.
4. Set up the developer environment in your computer.
   Recommended: Set it up as an Intellij project (follow the instructions in the README carefully as the steps are different from the iP).

Note that some of our bot scripts depend on the following folder paths. Please do not alter those paths in your project.

• /src/main/java
• /src/test/java
• /docs