tP week 7: Get ready for iterations

tP Team Organization Setup

(/) Only one team member:

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) : AY2021S1-TEAM_ID. e.g.  AY2021S1-TIC4001-2
  • 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.

tP Team Repo Setup

(/) Only one team member:

1. Fork the https://github.com/nus-tic4001-AY2021S1/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: our grading scripts rely on the repo name.

2. Enable the issue tracker.

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 are already included in the repo you forked.

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. Add members. Ensure your team members have the desired level of access to your team repo.
   Recommended: Give admin access to 1-2 members and write access to others.

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-tic4001-AY2021S1/tp] master branch. PR name: [Team ID] Product Name e.g., [TIC4001-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.
   Please fill in these details as specified because they are used by our grading scripts.

   • PR subject: the name of your product e.g., InsureList
   • Description: a 1-2 sentence overview (plain text only, no formatting or links) of your project indicating the target user and the value proposition e.g., InsureList helps insurance agents manage detail of their clients. It is optimized for CLI users so that frequent tasks can be done faster by typing in commands.

tP Individual Fork Setup

(, , , ...) Every team member:

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: our grading scripts rely on the repo name.
3. Clone the fork to your computer.
4. Set up the developer environment in your computer by following the the README carefully as the steps are different from the iP.

You can follow the steps in the simulation of a forking workflow given below to learn how to follow such a workflow.

This activity is best done as a team.

Step 1. One member: set up the team org and the team repo.

1. Create a GitHub organization for your team. The org name is up to you. We'll refer to this organization as team org from now on.

2. Add a team called developers to your team org.

3. Add team members to the developers team.

4. Fork se-edu/samplerepo-workflow-practice to your team org. We'll refer to this as the team repo.

5. Add the forked repo to the developers team. Give write access.

Step 2. Each team member: create PRs via own fork.

1. Fork that repo from your team org to your own GitHub account.

2. Create a branch named add-{your name}-info (e.g. add-johnTan-info) in the local repo.

3. Add a file yourName.md into the members directory (e.g., members/jonhTan.md) containing some info about you into that branch.

4. Push that branch to your fork.

5. Create a PR from that branch to the master branch of the team repo.

Step 3. For each PR: review, update, and merge.

1. [A team member (not the PR author)] Review the PR by adding comments (can be just dummy comments).

2. [PR author] Update the PR by pushing more commits to it, to simulate updating the PR based on review comments.

3. [Another team member] Approve and merge the PR using the GitHub interface.

4. [All members] Sync your local repo (and your fork) with upstream repo. In this case, your upstream repo is the repo in your team org.

Step 4. Create conflicting PRs.

1. [One member]: Update README: In the master branch, remove John Doe and Jane Doe from the README.md, commit, and push to the main repo.

2. [Each team member] Create a PR to add yourself under the Team Members section in the README.md. Use a new branch for the PR e.g., add-johnTan-name.

Step 5. Merge conflicting PRs one at a time. Before merging a PR, you’ll have to resolve conflicts.

1. [Optional] A member can inform the PR author (by posting a comment) that there is a conflict in the PR.

2. [PR author] Resolve the conflict locally:

   1. Pull the master branch from the repo in your team org.
   2. Merge the pulled master branch to your PR branch.
   3. Resolve the merge conflict that crops up during the merge.
   4. Push the updated PR branch to your fork.

3. [Another member or the PR author]: Merge the de-conflicted PR: When GitHub does not indicate a conflict anymore, you can go ahead and merge the PR.