The Schedule pageSchedule page is your main source of information for CS2103/T. You will need to refer to it weekly.

More details for the upcoming weeks will be added as the weeks progress. In general, information given for more than 1 week into the future should be treated as tentative.

This website uses a star rating system to indicate the priority level of contents.

Searching for keywords

Use the search box in the top navigation bar to search for keywords in the website pages. If you cannot find the content related to a keyword, let us know by posting in the website issue tracker so that we can add the missing keyword to our search index.

Printing Textbook Content

Printer-friendly version (indicated by icon) have been provided for each chapter and the whole book. You can use them for saving as pdf files or printing.

Making this Website Better

This website was generated using the MarkBind software developed at NUS. We welcome bug reports, suggestions, and contributions, to be submitted at the website issue tracker.

Star rating system

• [Direction 1] Optimize AddressBook for a more specific target user group:

  An AddressBook,

  • for users in a specific profession  e.g. doctors, salesmen, teachers, etc.
  • based on the nature/scale of contacts  e.g. huge number of contacts (for HR admins, user group admins), mostly incomplete contacts, highly volatile contact details, contacts become inactive after a specific period (e.g. contract employees)
  • based on what users do with the contacts  e.g. organize group events, share info, do business, do analytics

• [Direction 2] Morph AddressBook into a different product: Given that AddressBook is a generic app that manages a type of elements (i.e. contacts), you can use it as a starting point to create an app that manages something else.
  This is a high-risk high-reward option because morphing requires extra work but a morphed product may earn more marks than an optimized product of similar complexity.

  An app to manage,

  • Bookmarks of websites
  • Tasks/Schedule
  • Location info
  • Thing to memorize i.e. flash cards, trivia
  • Forum posts, news feeds, Social media feeds
  • Online projects or issue trackers that the user is interested in
  • Emails, possibly from different accounts
  • Multiple types of related things  e.g. Contacts and Tasks (if Tasks are allocated to Contacts)

For either direction, you need to define a target user profile and a value proposition:

• Target user profile: Define a very specific target user profile.
  💡 We require you to narrow down the target user profile  as opposed to trying to make it as general as possible. Here is an example direction of narrowing down target user: anybody → teachers → university teachers → tech savvy university teachers → CS2103/T instructors.
  
  Be careful not to contradict given project constraints when defining the user profile  e.g. the target user should still prefer typing over mouse actions.
  
  It is expected that your product will be optimized for the chosen target users i.e., add features that are especially/only applicable for target users (to make the app especially attractive to them). w.r.t. the example above, there can be features that are applicable to CS2103/T instructors only, such as the ability to navigate to a student's project on GitHub
  💡 Your project will be graded based on how well the features match the target user profile and how well the features fit-together.

  • It is an opportunity to exercise your product design skills because optimizing the product to a very specific target user requires good product design skills.
  • It minimizes the overlap between features of different teams which can cause plagiarism issues. Furthermore, higher the number of other teams having the same features, less impressive your work becomes especially if others have done a better job of implementing that feature.
  
  
• Value proposition: Define a clear value proposition (what problem does the product solve? how does it make the the user's life easier?) that matches the target user profile.

Decide on a overall project direction (user profile, problem addressed, optimize or morph?).

It is not too early to set an overall direction for your project.

• Set up a weekly project meeting time/venue with your team members

  We recommend at least one face-to-face project meeting per week. The project meeting time can be used to discuss project related things, but also, can be used as a time for team members to work on the project tasks individually (having all members in the same place will facilitate easier collaboration and more peer-learning).

• Play around with AB4

  Download the latest released version (i.e., the jar file) of AB4 from its upstream repo and play around with it to familiarize with its current features.

• Decide project direction, target user profile, and problem addressed

  Use your first project meeting to discuss with your team members and decide your project direction, target user profile, and the value proposition of the product, as described in [Admin Project Scope]

Decide on requirements (user stories, use cases, non-functional requirements).

💡 Given below are some guidance on the recommended progress at this point of the project (i.e., at week 4, which is the midway point of the milestone v1.0)

This is a good time to analyze requirements with a view to conceptualizing the next version of the product (i.e. v2.0).

• Step 1 : Brainstorm user stories

  

  Get together with your team members and brainstorm for user stories  for the v2.0 of the product. Note that in the module project you will deliver only up to v1.4 but here you should consider up to v2.0 (i.e. beyond the module).

  • It is ok to have more user stories than you can deliver in the project. Aim to create at least 30 user stories. Include all 'obvious' ones you can think of but also look for 'non obvious' ones that you think are likely to be missed by other teams.

  • Refer [Textbook Specifying Requirements → UserStories → Usage → (section) Tips] for tips on how to use user stories in this task.

  • You can write each user story in a piece of paper (e.g. yellow sticky note, index card, or just pieces of paper about the size of a playing card). Alternatively you can use an online tool (some examples given in [Textbook Specifying Requirements → UserStories → Usage → (panel) Tool Examples ]).
    

  • Note that you should not 'evaluate' the value of user stories while doing the above.  Reason: an important aspect of brainstorming is not judging the ideas generated.

 

Requirements → Specifying Requirements → User Stories →

Introduction

User story: User stories are short, simple descriptions of a feature told from the perspective of the person who desires the new capability, usually a user or customer of the system. _{[Mike Cohn]}

A common format for writing user stories is:

User story format: As a {user type/role} I can {function} so that {benefit}

Examples (from a Learning Management System):

1. As a student, I can download files uploaded by lecturers, so that I can get my own copy of the files
2. As a lecturer, I can create discussion forums, so that students can discuss things online
3. As a tutor, I can print attendance sheets, so that I can take attendance during the class

We can write user stories on index cards or sticky notes, and arrange on walls or tables, to facilitate planning and discussion. Alternatively, we can use a software (e.g., GitHub Project Boards, Trello, Google Docs, ...) to manage user stories digitally.

^{[credit: https://www.flickr.com/photos/jakuza/2682466984/]}

^{[credit: https://www.flickr.com/photos/jakuza/with/2726048607/]}

^{[credit: https://commons.wikimedia.org/wiki/File:User_Story_Map_in_Action.png]}

• a. They are based on stories users tell about similar systems
• b. They are written from the user/customer perspective
• c. They are always written in some physical medium such as index cards or sticky notes

• a. Reason: Despite the name, user stories are not related to 'stories' about the software.
• b.
• c. Reason: It is possible to use software to record user stories. When the team members are not co-located this may be the only option.

Critique the following user story taken from a software project to build an e-commerce website.

As a developer, I want to use Python to implement the software, so that we can resue existing Python modules.

Refer to the definition of a user story.

User story: User stories are short, simple descriptions of a feature told from the perspective of the person who desires the new capability, usually a user or customer of the system. _{[Mike Cohn]}

This user story is not written from the perspective of the user/customer.

Bill wants you to build a Human Resource Management (HRM) system. He mentions that the system will help employees to view their own leave balance. What are the user stories you can extract from that statement?

Remember to follow the correct format when writing user stories.

User story format: As a {user type/role} I can {function} so that {benefit}

As an employee, I can view my leave balance, so that I can know how many leave days I have left.

Note: the {benefit} part may vary as it is not specifically mentioned in the question.

• Step 2: Prioritize the user stories

  

  Suggested workflow:

  • Take one user story at a time and get team member opinions about it.

  • Based on the team consensus, put the story (i.e. the piece of paper) onto one of these three piles:

    • Must-Have : The product will be practically useless to the target user without this feature.
    • Nice-To-Have : The target user can benefit from this user story significantly but you are not certain if you'll have time to implement it.
    • Not-Useful : No significant benefit to the target user, or does not fit into the product vision.

  • If using physical paper to record user stories: After all stories have been put in the above three piles, you can make a record of which stories are in the three piles.

• Step 3: Document requirements of the product

  Based on your user story categorization in the step above, given module requirements/constraints for the project, and the current state of the product, select which user stories you are likely to include in v2.0.

  Document the following items using a convenient format (e.g., a GoogleDoc). Do not spend time on formatting the content nicely; reason: these will be ported to the actual Developer Guide in your project repo later.
  💡 Some examples of these can be found in the AB4 Developer Guide.

  • Target user profile, value proposition, and user stories: Update the target user profile and value proposition to match the project direction you have selected. Give a list of the user stories (and update/delete existing ones, if applicable), including priorities. This can include user stories considered but will not be included in the final product.
  • Use cases: Give use cases (textual form) for a few representative user stories that need multiple steps to complete. e.g. Adding a tag to a person (assume the user needs to find the person first)
  • Non-functional requirements:
    Note: Many of the project constraints mentioned above are NFRs. You can add more. e.g. performance requirements, usability requirements, scalability requirements, etc.
  • Glossary: Define terms that are worth defining.
  • [Optional]Product survey: Explore a few similar/related products and describe your findings i.e. Pros, cons, (from the target user's point of view).

 

Requirements → Specifying Requirements → Use Cases →

Introduction

Use Case: A description of a set of sequences of actions, including variants, that a system performs to yield an observable result of value to an actor.[ 📖 : uml-user-guideThe Unified Modeling Language User Guide, 2e, G Booch, J Rumbaugh, and I Jacobson ]

Actor: An actor (in a use case) is a role played by a user. An actor can be a human or another system. Actors are not part of the system; they reside outside the system.

A use case describes an interaction between the user and the system for a specific functionality of the system.

• System: ATM
• Actor: Customer
• Use Case: Check account balance
  1. User inserts an ATM card
  2. ATM prompts for PIN
  3. User enters PIN
  4. ATM prompts for withdrawal amount
  5. User enters the amount
  6. ATM ejects the ATM card and issues cash
  7. User collects the card and the cash.

• System: A Learning Management System (LMS)
• Actor: Student
• Use Case: Upload file
  1. Student requests to upload file
  2. LMS requests for the file location
  3. Student specifies the file location
  4. LMS uploads the file

UML includes a diagram type called use case diagrams that can illustrate use cases of a system visually , providing a visual ‘table of contents’ of the use cases of a system. In the example below, note how use cases are shown as ovals and user roles relevant to each use case are shown as stick figures connected to the corresponding ovals.

Unified Modeling Language (UML) is a graphical notation to describe various aspects of a software system. UML is the brainchild of three software modeling specialists James Rumbaugh, Grady Booch and Ivar Jacobson (also known as the Three Amigos). Each of them has developed their own notation for modeling software systems before joining force to create a unified modeling language (hence, the term ‘Unified’ in UML). UML is currently the de facto modeling notation used in the software industry.

Use cases capture the functional requirements of a system.

Conceptualize product and document it as a user guide(draft), draft a rough project plan.

v1.0 Summary of Milestone

Here is a summary of items you need to deliver to reach v1.0 individual () and team () milestones. See sections below for more details of each item.

Reaching individual and team milestones are considered for grading the project management component of your project grade (expand the panel below for more info).

The deadline for reaching a milestone is the midnight before your tutorial e.g., if your tutorial is on Wednesday, you need to reach the milestone by Tuesday midnight.

v1.0 Documentation

• Developer Guide: Have a draft of the requirements of your project, as described in mid-v1.0 progress guide.

 

Decide on requirements (user stories, use cases, non-functional requirements).

💡 Given below are some guidance on the recommended progress at this point of the project (i.e., at week 4, which is the midway point of the milestone v1.0)

This is a good time to analyze requirements with a view to conceptualizing the next version of the product (i.e. v2.0).

• Step 1 : Brainstorm user stories

  

  Get together with your team members and brainstorm for user stories  for the v2.0 of the product. Note that in the module project you will deliver only up to v1.4 but here you should consider up to v2.0 (i.e. beyond the module).

  • It is ok to have more user stories than you can deliver in the project. Aim to create at least 30 user stories. Include all 'obvious' ones you can think of but also look for 'non obvious' ones that you think are likely to be missed by other teams.

  • Refer [Textbook Specifying Requirements → UserStories → Usage → (section) Tips] for tips on how to use user stories in this task.

  • You can write each user story in a piece of paper (e.g. yellow sticky note, index card, or just pieces of paper about the size of a playing card). Alternatively you can use an online tool (some examples given in [Textbook Specifying Requirements → UserStories → Usage → (panel) Tool Examples ]).
    

  • Note that you should not 'evaluate' the value of user stories while doing the above.  Reason: an important aspect of brainstorming is not judging the ideas generated.

 

Requirements → Gathering Requirements →

Brainstorming

Brainstorming: A group activity designed to generate a large number of diverse and creative ideas for the solution of a problem.

In a brainstorming session there are no "bad" ideas. The aim is to generate ideas; not to validate them. Brainstorming encourages you to "think outside the box" and put "crazy" ideas on the table without fear of rejection.

What is the key characteristic about brainstorming?

• a. There should be at least 5 participants.
• b. All ideas are welcome. There are no bad ideas.
• c. Only the best people in the team should take part.
• d. They are a good way to eliminate bad ideas.

(b)

 

Requirements → Specifying Requirements → User Stories →

Introduction

User story: User stories are short, simple descriptions of a feature told from the perspective of the person who desires the new capability, usually a user or customer of the system. _{[Mike Cohn]}

A common format for writing user stories is:

User story format: As a {user type/role} I can {function} so that {benefit}

Examples (from a Learning Management System):

1. As a student, I can download files uploaded by lecturers, so that I can get my own copy of the files
2. As a lecturer, I can create discussion forums, so that students can discuss things online
3. As a tutor, I can print attendance sheets, so that I can take attendance during the class

We can write user stories on index cards or sticky notes, and arrange on walls or tables, to facilitate planning and discussion. Alternatively, we can use a software (e.g., GitHub Project Boards, Trello, Google Docs, ...) to manage user stories digitally.

^{[credit: https://www.flickr.com/photos/jakuza/2682466984/]}

^{[credit: https://www.flickr.com/photos/jakuza/with/2726048607/]}

^{[credit: https://commons.wikimedia.org/wiki/File:User_Story_Map_in_Action.png]}

• a. They are based on stories users tell about similar systems
• b. They are written from the user/customer perspective
• c. They are always written in some physical medium such as index cards or sticky notes

• a. Reason: Despite the name, user stories are not related to 'stories' about the software.
• b.
• c. Reason: It is possible to use software to record user stories. When the team members are not co-located this may be the only option.

Critique the following user story taken from a software project to build an e-commerce website.

As a developer, I want to use Python to implement the software, so that we can resue existing Python modules.

Refer to the definition of a user story.

User story: User stories are short, simple descriptions of a feature told from the perspective of the person who desires the new capability, usually a user or customer of the system. _{[Mike Cohn]}

This user story is not written from the perspective of the user/customer.

Bill wants you to build a Human Resource Management (HRM) system. He mentions that the system will help employees to view their own leave balance. What are the user stories you can extract from that statement?

Remember to follow the correct format when writing user stories.

User story format: As a {user type/role} I can {function} so that {benefit}

As an employee, I can view my leave balance, so that I can know how many leave days I have left.

Note: the {benefit} part may vary as it is not specifically mentioned in the question.

 

 

You can create issues for each of the user stories and use a GitHub Project Board to sort them into categories.

Example Project Board:

Example Issue to represent a user story:

A video on GitHub Project Boards:

---

 

Example Google Sheet for recording user stories:

---

 

Example Trello Board for recording user stories:

---

 

Given their lightweight nature, user stories are quite handy for recording requirements during early stages of requirements gathering.

💡 Here are some tips for using user stories for early stages of requirement gathering:

• Define the target user:
  Decide your target user's profile (e.g. a student, office worker, programmer, sales person) and work patterns (e.g. Does he work in groups or alone? Does he share his computer with others?). A clear understanding of the target user will help when deciding the importance of a user story. You can even give this user a name.  e.g. Target user Jean is a university student studying in a non-IT field. She interacts with a lot of people due to her involvement in university clubs/societies. ...
• Define the problem scope: Decide that exact problem you are going to solve for the target user.  e.g. Help Jean keep track of all her school contacts
• Don't be too hasty to discard 'unusual' user stories:
  Those might make your product unique and stand out from the rest, at least for the target users.
• Don't go into too much details:
  For example, consider this user story: As a user, I want to see a list of tasks that needs my attention most at the present time, so that I pay attention to them first.
  When discussing this user story, don't worry about what tasks should be considered needs my attention most at the present time. Those details can be worked out later.
• Don't be biased by preconceived product ideas:
  When you are at the stage of identifying user needs, clear your mind of ideas you have about what your end product will look like.
• Don't discuss implementation details or whether you are actually going to implement it:
  When gathering requirements, your decision is whether the user's need is important enough for you to want to fulfil it. Implementation details can be discussed later. If a user story turns out to be too difficult to implement later, you can always omit it from the implementation plan.

💡 Recommended: You can use GitHub issue tracker to manage user stories, but for that you need to set up your team's GitHub organization, project fork, and issue tracker first. Instructions for doing those steps are in the panel below.

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 : CS2103-AY1819S1-TEAM_ID. e.g.  CS2103-AY1819S1-W12-1
  • Plan:  Open Source ($0/month)
• Add members to the organization:
  • Create a team called developers to your organization.
  • Add your team members to the developers team.

Repo setup

Only one team member:

1. Fork Address Book Level 4 to your team org.
2. Rename the forked repo as main. This repo (let's call it the team repo) is to be used as the repo for your project.
3. Ensure the issue tracker of your team repo is enabled. Reason: our bots will be posting your weekly progress reports on the issue tracker of your team repo.
4. Ensure your team members have the desired level of access to your team repo.
5. Enable Travis CI for the team repo.
6. Set up auto-publishing of docs. When set up correctly, your project website should be available via the URL https://nus-cs2103-ay1819s1-{team-id}.github.io/main e.g., https://cs2103-ay1819s1-w13-1.github.io/main/. This also requires you to enable the GitHub Pages feature of your team repo and configure it to serve the website from the gh-pages branch.
7. create a team PR for us to track your project progress: i.e., create a PR from your team repo master branch to [nus-cs2103-AY1819S1/addressbook-level4] master branch. PR name: [Team ID] Product Name e.g., [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 @mention the other team members so that they get notified when the tutor adds comments to the PR.

All team members:

1. Watchthe main 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 main repo to your personal GitHub account.
3. Clone the fork to your Computer.
4. Recommended: Set it up as an Intellij project (follow the instructions in the Developer Guide carefully).
5. Set up the developer environment in your computer. You are recommended to use JDK 9 for AB-4 as some of the libraries used in AB-4 have not updated to support Java 10 yet. JDK 9 can be downloaded from the Java Archive.

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

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

Issue tracker setup

We recommend you configure the issue tracker of the main repo as follows:

• Delete existing labels and add the following labels.
  💡 Issue type labels are useful from the beginning of the project. The other labels are needed only when you start implementing the features.

Issue type labels:

• type.Epic : A big feature which can be broken down into smaller stories e.g. search
• type.Story : A user story
• type.Enhancement: An enhancement to an existing story
• type.Task : Something that needs to be done, but not a story, bug, or an epic. e.g. Move testing code into a new folder)
• type.Bug : A bug

Status labels:

• status.Ongoing : The issue is currently being worked on. note: remove this label before closing an issue.

Priority labels:

• priority.High : Must do
• priority.Medium : Nice to have
• priority.Low : Unlikely to do

Bug Severity labels:

• severity.Low : A flaw that is unlikely to affect normal operations of the product. Appears only in very rare situations and causes a minor inconvenience only.
• severity.Medium : A flaw that causes occasional inconvenience to some users but they can continue to use the product.
• severity.High : A flaw that affects most users and causes major problems for users. i.e., makes the product almost unusable for most users.

• Create following milestones : v1.0, v1.1, v1.2, v1.3, v1.4,

• You may configure other project settings as you wish. e.g. more labels, more milestones

Project Schedule Tracking

In general, use the issue tracker (Milestones, Issues, PRs, Tags, Releases, and Labels) for assigning, scheduling, and tracking all noteworthy project tasks, including user stories. Update the issue tracker regularly to reflect the current status of the project. You can also use GitHub's Projects feature to manage the project, but keep it linked to the issue tracker as much as you can.

Using Issues:

During the initial stages (latest by the start of v1.2):

• Record each of the user stories you plan to deliver as an issue in the issue tracker. e.g. Title: As a user I can add a deadline
Description: ... so that I can keep track of my deadlines

• Assign the type.* and priority.* labels to those issues.

• Formalize the project plan by assigning relevant issues to the corresponding milestone.

From milestone v1.2:

• Define project tasks as issues. When you start implementing a user story (or a feature), break it down to smaller tasks if necessary. Define reasonable sized, standalone tasks. Create issues for each of those tasks so that they can be tracked.e.g.

  • A typical task should be able to done by one person, in a few hours.

    • Bad (reasons: not a one-person task, not small enough): Write the Developer Guide
    • Good: Update class diagram in the Developer Guide for v1.4

  • There is no need to break things into VERY small tasks. Keep them as big as possible, but they should be no bigger than what you are going to assign a single person to do within a week. eg.,

    • Bad:Implementing parser (reason: too big).
    • Good:Implementing parser support for adding of floating tasks

  • Do not track things taken for granted. e.g., push code to repo should not be a task to track. In the example given under the previous point, it is taken for granted that the owner will also (a) test the code and (b) push to the repo when it is ready. Those two need not be tracked as separate tasks.

  • Write a descriptive title for the issue. e.g. Add support for the 'undo' command to the parser

    • Omit redundant details. In some cases, the issue title is enough to describe the task. In that case, no need to repeat it in the issue description. There is no need for well-crafted and detailed descriptions for tasks. A minimal description is enough. Similarly, labels such as priority can be omitted if you think they don't help you.
      
      

• Assign tasks (i.e., issues) to the corresponding team members using the assignees field. Normally, there should be some ongoing tasks and some pending tasks against each team member at any point.

• Optionally, you can use status.ongoing label to indicate issues currently ongoing.

Using Milestones:

We recommend you do proper milestone management starting from v1.2. Given below are the conditions to satisfy for a milestone to be considered properly managed:

Planning a Milestone:

• Issues assigned to the milestone, team members assigned to issues: Used GitHub milestones to indicate which issues are to be handled for which milestone by assigning issues to suitable milestones. Also make sure those issues are assigned to team members. Note that you can change the milestone plan along the way as necessary.

• Deadline set for the milestones (in the GitHub milestone). Your internal milestones can be set earlier than the deadlines we have set, to give you a buffer.

Wrapping up a Milestone:

• A working product tagged with the correct tag (e.g. v1.2) and is pushed to the main repo
  or a product release done on GitHub. A product release is optional for v1.2 but required from from v1.3. Click here to see an example release.

• All tests passing on Travis for the version tagged/released.

• Milestone updated to match the product i.e. all issues completed and PRs merged for the milestone should be assigned to the milestone. Incomplete issues/PRs should be moved to a future milestone.
  

• Milestone closed.
  

• If necessary, future milestones are revised based on what you experienced in the current milestone  e.g. if you could not finish all issues assigned to the current milestone, it is a sign that you overestimated how much you can do in a week, which means you might want to reduce the issues assigned to future milestones to match that observation.

As a user I can add a task by specifying a task description only, so that I can record tasks that need to be done ‘some day’. As a user I can find upcoming tasks, so that I can decide what needs to be done soon. As a user I can delete a task, so that I can get rid of tasks that I no longer care to track. As a new user I can view more information about a particular command, so that I can learn how to use various commands. As an advanced user I can use shorter versions of a command, so that type a command faster.

• Step 2: Prioritize the user stories

  

  Suggested workflow:

  • Take one user story at a time and get team member opinions about it.

  • Based on the team consensus, put the story (i.e. the piece of paper) onto one of these three piles:

    • Must-Have : The product will be practically useless to the target user without this feature.
    • Nice-To-Have : The target user can benefit from this user story significantly but you are not certain if you'll have time to implement it.
    • Not-Useful : No significant benefit to the target user, or does not fit into the product vision.

  • If using physical paper to record user stories: After all stories have been put in the above three piles, you can make a record of which stories are in the three piles.

• Step 3: Document requirements of the product

  Based on your user story categorization in the step above, given module requirements/constraints for the project, and the current state of the product, select which user stories you are likely to include in v2.0.

  Document the following items using a convenient format (e.g., a GoogleDoc). Do not spend time on formatting the content nicely; reason: these will be ported to the actual Developer Guide in your project repo later.
  💡 Some examples of these can be found in the AB4 Developer Guide.

  • Target user profile, value proposition, and user stories: Update the target user profile and value proposition to match the project direction you have selected. Give a list of the user stories (and update/delete existing ones, if applicable), including priorities. This can include user stories considered but will not be included in the final product.
  • Use cases: Give use cases (textual form) for a few representative user stories that need multiple steps to complete. e.g. Adding a tag to a person (assume the user needs to find the person first)
  • Non-functional requirements:
    Note: Many of the project constraints mentioned above are NFRs. You can add more. e.g. performance requirements, usability requirements, scalability requirements, etc.
  • Glossary: Define terms that are worth defining.
  • [Optional]Product survey: Explore a few similar/related products and describe your findings i.e. Pros, cons, (from the target user's point of view).

 

Requirements → Specifying Requirements → Use Cases →

Introduction

Use Case: A description of a set of sequences of actions, including variants, that a system performs to yield an observable result of value to an actor.[ 📖 : uml-user-guideThe Unified Modeling Language User Guide, 2e, G Booch, J Rumbaugh, and I Jacobson ]

Actor: An actor (in a use case) is a role played by a user. An actor can be a human or another system. Actors are not part of the system; they reside outside the system.

A use case describes an interaction between the user and the system for a specific functionality of the system.

• System: ATM
• Actor: Customer
• Use Case: Check account balance
  1. User inserts an ATM card
  2. ATM prompts for PIN
  3. User enters PIN
  4. ATM prompts for withdrawal amount
  5. User enters the amount
  6. ATM ejects the ATM card and issues cash
  7. User collects the card and the cash.

• System: A Learning Management System (LMS)
• Actor: Student
• Use Case: Upload file
  1. Student requests to upload file
  2. LMS requests for the file location
  3. Student specifies the file location
  4. LMS uploads the file

UML includes a diagram type called use case diagrams that can illustrate use cases of a system visually , providing a visual ‘table of contents’ of the use cases of a system. In the example below, note how use cases are shown as ovals and user roles relevant to each use case are shown as stick figures connected to the corresponding ovals.

Unified Modeling Language (UML) is a graphical notation to describe various aspects of a software system. UML is the brainchild of three software modeling specialists James Rumbaugh, Grady Booch and Ivar Jacobson (also known as the Three Amigos). Each of them has developed their own notation for modeling software systems before joining force to create a unified modeling language (hence, the term ‘Unified’ in UML). UML is currently the de facto modeling notation used in the software industry.

Use cases capture the functional requirements of a system.

 

Requirements → Requirements →

Non-Functional Requirements

There are two kinds of requirements:

1. Functional requirements specify what the system should do.
2. Non-functional requirements specify the constraints under which system is developed and operated.

Some examples of non-functional requirement categories:

• Data requirements e.g. size, volatility, persistency etc.,
• Environment requirements e.g. technical environment in which system would operate or need to be compatible with.
• Accessibility, Capacity, Compliance with regulations, Documentation, Disaster recovery, Efficiency, Extensibility, Fault tolerance, Interoperability, Maintainability, Privacy, Portability, Quality, Reliability, Response time, Robustness, Scalability, Security, Stability, Testability, and more ...

• Business/domain rules: e.g. the size of the minefield cannot be smaller than five.
• Constraints: e.g. the system should be backward compatible with data produced by earlier versions of the system; system testers are available only during the last month of the project; the total project cost should not exceed $1.5 million.
• Technical requirements: e.g. the system should work on both 32-bit and 64-bit environments.
• Performance requirements: e.g. the system should respond within two seconds.
• Quality requirements: e.g. the system should be usable by a novice who has never carried out an online purchase.
• Process requirements: e.g. the project is expected to adhere to a schedule that delivers a feature set every one month.
• Notes about project scope: e.g. the product is not required to handle the printing of reports.
• Any other noteworthy points: e.g. the game should not use images deemed offensive to those injured in real mine clearing activities.

We may have to spend an extra effort in digging NFRs out as early as possible because,

1. NFRs are easier to miss  e.g., stakeholders tend to think of functional requirements first
2. sometimes NFRs are critical to the success of the software.  E.g. A web application that is too slow or that has low security is unlikely to succeed even if it has all the right functionality.

Given below are some requirements of TEAMMATES (an online peer evaluation system for education). Which one of these are non-functional requirements?

• a. The response to any use action should become visible within 5 seconds.
• b. The application admin should be able to view a log of user activities.
• c. The source code should be open source.
• d. A course should be able to have up to 2000 students.
• e. As a student user, I can view details of my team members so that I can know who they are.
• f. The user interface should be intuitive enough for users who are not IT-savvy.
• g. The product is offered as a free online service.

(a)(c)(d)(f)(g)

Explanation: (b) are (e) are functions available for a specific user types. Therefore, they are functional requirements. (a), (c), (d), (f) and (g) are either constraints on functionality or constraints on how the project is done, both of which are considered non-functional requirements.

 

Requirements → Specifying Requirements → Glossary →

What

Glossary: A glossary serves to ensure that all stakeholders have a common understanding of the noteworthy terms, abbreviation, acronyms etc.

Here is a partial glossary from a variant of the Snakes and Ladders game:

• Conditional square: A square that specifies a specific face value which a player has to throw before his/her piece can leave the square.
• Normal square: a normal square does not have any conditions, snakes, or ladders in it.

 

Requirements → Gathering Requirements →

Product Surveys

Studying existing products can unearth shortcomings of existing solutions that can be addressed by a new product. Product manuals and other forms of technical documentation of an existing system can be a good way to learn about how the existing solutions work.

When developing a game for a mobile device, a look at a similar PC game can give insight into the kind of features and interactions the mobile game can offer.

• User Guide:
  Draft a user guide in a convenient medium (e.g., a GoogleDoc) to describe what the product would be like when it is at v2.0.

  • We recommend that you follow the existing AB4 User Guide in terms of structure and format.
  • As this is a very rough draft and the final version will be in a different format altogether (i.e., in asciidoc format), don't waste time in formatting, copy editing etc. It is fine as long as the tutor can get a rough idea of the features from this draft. You can also do just the 'Features' section and omit the other parts.
  • Do try to come up with concrete command syntax for feature that you would implement (at least for those that you will implement by v1.4).
  • Consider including some UI mock-ups too (they can be hand-drawn or created using a tool such as PowerPoint or Balsamiq).

  💡 It is highly recommended that you divide documentation work (in the User Guide and the Developer Guide) among team members based on enhancements/features each person would be adding  e.g., If you are the person planing to add a feature X, you should be the person to describe the feature X in the User Guide and in the Developer Guide. For features that are not planned to be implemented by v1.4, you can divide them based on who will be implementing them if the project were to continue until v2.0 (hypothetically).

  Reason: In the final project evaluation your documentation skills will be graded based on sections of the User/Developer Guide you have written.

Suggested length: Follow the existing user guide and developer guides in terms of the level of details.

Submission : Save your draft a single pdf file, name it {Your Team ID}.pdf e.g., W09-3.pdf and upload to IVLE.

v1.0 Project Management

• After the v2.0 is conceptualized, decide which features each member will do by v1.4. We realize that it will be hard for you to estimate the effort required for each feature as you are not familiar with the code base. Nevertheless, come up with a project plan as per your best estimate; this plan can be revised at later stages. It is better to start with some plan rather than no plan at all. If in doubt, choose to do less than more; we don't expect you to deliver a lot of big features.

• Divide each of those features into three increments, to be released at v1.1, v1.2, v1.3 (v1.4 omitted deliberately as a buffer). Ideally, each increment should deliver a end-user testable enhancement.

• Document the above two items somewhere e.g., in a Google doc/sheet. An example is given below:

  * Jake Woo: Profile photo feature
    * v1.1: show a place holder for photo, showing a generic default image
    * v1.2: can specify photo location if it is in local hard disk,
            show photo from local hard disk
    * v1.3: auto-copy the photo to app folder, support using online photo
            as profile pic, stylize photo e.g., round frame
  

Submission : Include in the pdf file you upload to IVLE.

Set up project repo, start moving UG and DG to the repo, attempt to do local-impact changes to the code base.

Project Management:

Set up the team org and the team repo as explained below:

Relevant: [Admin Appendix E(extract): Organization setup ]

 

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 : CS2103-AY1819S1-TEAM_ID. e.g.  CS2103-AY1819S1-W12-1
  • Plan:  Open Source ($0/month)
• Add members to the organization:
  • Create a team called developers to your organization.
  • Add your team members to the developers team.

Relevant: [Admin Appendix E(extract): Repo setup ]

 

Repo setup

Only one team member:

1. Fork Address Book Level 4 to your team org.
2. Rename the forked repo as main. This repo (let's call it the team repo) is to be used as the repo for your project.
3. Ensure the issue tracker of your team repo is enabled. Reason: our bots will be posting your weekly progress reports on the issue tracker of your team repo.
4. Ensure your team members have the desired level of access to your team repo.
5. Enable Travis CI for the team repo.
6. Set up auto-publishing of docs. When set up correctly, your project website should be available via the URL https://nus-cs2103-ay1819s1-{team-id}.github.io/main e.g., https://cs2103-ay1819s1-w13-1.github.io/main/. This also requires you to enable the GitHub Pages feature of your team repo and configure it to serve the website from the gh-pages branch.
7. create a team PR for us to track your project progress: i.e., create a PR from your team repo master branch to [nus-cs2103-AY1819S1/addressbook-level4] master branch. PR name: [Team ID] Product Name e.g., [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 @mention the other team members so that they get notified when the tutor adds comments to the PR.

All team members:

1. Watchthe main 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 main repo to your personal GitHub account.
3. Clone the fork to your Computer.
4. Recommended: Set it up as an Intellij project (follow the instructions in the Developer Guide carefully).
5. Set up the developer environment in your computer. You are recommended to use JDK 9 for AB-4 as some of the libraries used in AB-4 have not updated to support Java 10 yet. JDK 9 can be downloaded from the Java Archive.

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

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

When updating code in the repo, follow the workflow explained below:

Relevant: [Admin Appendix E(extract): Workflow ]

 

Workflow

Before you do any coding for the project,

• Ensure you have set the Git username correctly (as explained in Appendix E) in all Computers you use for coding.
• Read our reuse policy (in Admin: Appendix B), in particular, how to give credit when you reuse code from the Internet or classmates:

 

Setting Git Username to Match GitHub Username

We use various tools to analyze your code. For us to be able to identify your commits, you should use the GitHub username as your Git username as well. If there is a mismatch, or if you use multiple user names for Git, our tools might miss some of your work and as a result you might not get credit for some of your work.

In each Computer you use for coding, after installing Git, you should set the Git username as follows.

1. Open a command window that can run Git commands (e.g., Git bash window)
2. Run the command git config --global user.name YOUR_GITHUB_USERNAME
   e.g., git config --global user.name JohnDoe

More info about setting Git username is here.

 

Policy on reuse

Reuse is encouraged. However, note that reuse has its own costs (such as the learning curve, additional complexity, usage restrictions, and unknown bugs). Furthermore, you will not be given credit for work done by others. Rather, you will be given credit for using work done by others.

• You are allowed to reuse work from your classmates, subject to following conditions:
  • The work has been published by us or the authors.
  • You clearly give credit to the original author(s).
• You are allowed to reuse work from external sources, subject to following conditions:
  • The work comes from a source of 'good standing' (such as an established open source project). This means you cannot reuse code written by an outside 'friend'.
  • You clearly give credit to the original author. Acknowledge use of third party resources clearly e.g. in the welcome message, splash screen (if any) or under the 'about' menu. If you are open about reuse, you are less likely to get into trouble if you unintentionally reused something copyrighted.
  • You do not violate the license under which the work has been released. Please  do not use 3rd-party images/audio in your software unless they have been specifically released to be used freely. Just because you found it in the Internet does not mean it is free for reuse.
  • Always get permission from us before you reuse third-party libraries. Please post your 'request to use 3rd party library' in our forum. That way, the whole class get to see what libraries are being used by others.

Giving credit for reused work

Given below are how to give credit for things you reuse from elsewhere. These requirements are specific to this module  i.e., not applicable outside the module (outside the module you should follow the rules specified by your employer and the license of the reused work)

If you used a third party library:

• Mention in the README.adoc (under the Acknowledgements section)
• mention in the Project Portfolio Page if the library has a significant relevance to the features you implemented

If you reused code snippets found on the Internet  e.g. from StackOverflow answers or
referred code in another software or
referred project code by current/past student:

• If you read the code to understand the approach and implemented it yourself, mention it as a comment
  Example:

  //Solution below adapted from https://stackoverflow.com/a/16252290
  {Your implmentation of the reused solution here ...}
  

• If you copy-pasted a non-trivial code block (possibly with minor modifications  renaming, layout changes, changes to comments, etc.), also mark the code block as reused code (using @@author tags)
  Format:

  //@@author {yourGithubUsername}-reused
  //{Info about the source...}
  
  {Reused code (possibly with minor modifications) here ...}
  
  //@@author
  

  Example of reusing a code snippet (with minor modifications):

  persons = getList()
  //@@author johndoe-reused
  //Reused from https://stackoverflow.com/a/34646172 with minor modifications
  Collections.sort(persons, new Comparator<CustomData>() {
      @Override
      public int compare(CustomData lhs, CustomData rhs) {
          return lhs.customInt > rhs.customInt ? -1 : (lhs.customInt < rhs.customInt) ? 1 : 0;
      }
  });
  //@@author
  return persons;
  

 

Adding @@author tags indicate authorship

• Mark your code with a //@@author {yourGithubUsername}. Note the double @.
  The //@@author tag should indicates the beginning of the code you wrote. The code up to the next //@@author tag or the end of the file (whichever comes first) will be considered as was written by that author. Here is a sample code file:

  //@@author johndoe
  method 1 ...
  method 2 ...
  //@@author sarahkhoo
  method 3 ...
  //@@author johndoe
  method 4 ...
  

• If you don't know who wrote the code segment below yours, you may put an empty //@@author (i.e. no GitHub username) to indicate the end of the code segment you wrote. The author of code below yours can add the GitHub username to the empty tag later. Here is a sample code with an empty author tag:

  method 0 ...
  //@@author johndoe
  method 1 ...
  method 2 ...
  //@@author
  method 3 ...
  method 4 ...
  

• The author tag syntax varies based on file type e.g. for java, css, fxml. Use the corresponding comment syntax for non-Java files.
  Here is an example code from an xml/fxml file.

  <!-- @@author sereneWong -->
  <textbox>
    <label>...</label>
    <input>...</input>
  </textbox>
  ...
  

• Do not put the //@@author inside java header comments.
  👎

  /**
    * Returns true if ...
    * @@author johndoe
    */
  

  👍

  //@@author johndoe
  /**
    * Returns true if ...
    */
  

What to and what not to annotate

• Annotate both functional and test code There is no need to annotate documentation files.

• Annotate only significant size code blocks that can be reviewed on its own  e.g., a class, a sequence of methods, a method.
  Claiming credit for code blocks smaller than a method is discouraged but allowed. If you do, do it sparingly and only claim meaningful blocks of code such as a block of statements, a loop, or an if-else statement.

  • If an enhancement required you to do tiny changes in many places, there is no need to annotate all those tiny changes; you can describe those changes in the Project Portfolio page instead.
  • If a code block was touched by more than one person, either let the person who wrote most of it (e.g. more than 80%) take credit for the entire block, or leave it as 'unclaimed' (i.e., no author tags).
  • Related to the above point, if you claim a code block as your own, more than 80% of the code in that block should have been written by yourself. For example, no more than 20% of it can be code you reused from somewhere.
  • 💡 GitHub has a blame feature and a history feature that can help you determine who wrote a piece of code.

• Do not try to boost the quantity of your contribution using unethical means such as duplicating the same code in multiple places. In particular, do not copy-paste test cases to create redundant tests. Even repetitive code blocks within test methods should be extracted out as utility methods to reduce code duplication. Individual members are responsible for making sure code attributed to them are correct. If you notice a team member claiming credit for code that he/she did not write or use other questionable tactics, you can email us (after the final submission) to let us know.

• If you wrote a significant amount of code that was not used in the final product,

  • Create a folder called {project root}/unused
  • Move unused files (or copies of files containing unused code) to that folder
  • use //@@author {yourGithubUsername}-unused to mark unused code in those files (note the suffix unused) e.g.

  //@@author johndoe-unused
  method 1 ...
  method 2 ...
  

  Please put a comment in the code to explain why it was not used.

• If you reused code from elsewhere, mark such code as //@@author {yourGithubUsername}-reused (note the suffix reused) e.g.

  //@@author johndoe-reused
  method 1 ...
  method 2 ...
  

• You can use empty @@author tags to mark code as not yours when RepoSense attribute the to you incorrectly.

  • Code generated by the IDE/framework, should not be annotated as your own.

  • Code you modified in minor ways e.g. adding a parameter. These should not be claimed as yours but you can mention these additional contributions in the Project Portfolio page if you want to claim credit for them.

 

At the end of the project each student is required to submit a Project Portfolio Page.

• Objective:

  • For you to use  (e.g. in your resume) as a well-documented data point of your SE experience
  • For us to use as a data point to evaluate your,
    • contributions to the project
    • your documentation skills

• Sections to include:

  • Overview: A short overview of your product to provide some context to the reader.

  • Summary of Contributions:

    • Code contributed: Give a link to your code on Project Code Dashboard, which should be https://nus-cs2103-ay1819s1.github.io/cs2103-dashboard/#=undefined&search=githbub_username_in_lower_case (replace githbub_username_in_lower_case with your actual username in lower case e.g., johndoe). This link is also available in the Project List Page -- linked to the icon under your photo.
    • Main feature implemented: A summary of the main feature (the so called major enhancement) you implemented
    • Other contributions:
      • Other minor enhancements you did which are not related to your main feature
      • Contributions to project management e.g., setting up project tools, managing releases, managing issue tracker etc.
      • Evidence of helping others e.g. responses you posted in our forum, bugs you reported in other team's products,
      • Evidence of technical leadership e.g. sharing useful information in the forum

  • Contributions to the User Guide: Reproduce the parts in the User Guide that you wrote. This can include features you implemented as well as features you propose to implement.
    The purpose of allowing you to include proposed features is to provide you more flexibility to show your documentation skills. e.g. you can bring in a proposed feature just to give you an opportunity to use a UML diagram type not used by the actual features.

  • Contributions to the Developer Guide: Reproduce the parts in the Developer Guide that you wrote. Ensure there is enough content to evaluate your technical documentation skills and UML modelling skills. You can include descriptions of your design/implementations, possible alternatives, pros and cons of alternatives, etc.

  • If you plan to use the PPP in your Resume, you can also include your SE work outside of the module (will not be graded)

• Format:

  • File name: docs/team/githbub_username_in_lower_case.adoc e.g., docs/team/johndoe.adoc

  • Follow the example in the AddressBook-Level4, but ignore the following two lines in it.
    

    • Minor enhancement: added a history command that allows the user to navigate to previous commands using up/down keys.
    • Code contributed: [Functional code] [Test code] {give links to collated code files}

  • 💡 You can use the Asciidoc's include feature to include sections from the developer guide or the user guide in your PPP. Follow the example in the sample.

  • It is assumed that all contents in the PPP were written primarily by you. If any section is written by someone else  e.g. someone else wrote described the feature in the User Guide but you implemented the feature, clearly state that the section was written by someone else  (e.g. Start of Extract [from: User Guide] written by Jane Doe).  Reason: Your writing skills will be evaluated based on the PPP

  • Page limit: If you have more content than the limit given below, shorten (or omit some content) so that you do not exceed the page limit. Having too much content in the PPP will be viewed unfavorably during grading. Note: the page limits given below are after converting to PDF format. The actual amount of content you require is actually less than what these numbers suggest because the HTML → PDF conversion adds a lot of spacing around content.

    Content	Limit
    Overview + Summary of contributions	0.5-1
    Contributions to the User Guide	1-3
    Contributions to the Developer Guide	3-6
    Total	5-10

Follow the forking workflow in your project up to v1.1. In particular,

• Get team members to review PRs. A workflow without PR reviews is a risky workflow.
• Do not merge PRs failing CI. After setting up Travis, the CI status of a PR is reported at the bottom of the PR page. The screenshot below shows the status of a PR that is passing all CI checks.
  
  If there is a failure, you can click on the Details link in corresponding line to find out more about the failure. Once you figure out the cause of the failure, push the a fix to the PR.
• After setting up Netlify, you can use Netlify PR Preview to preview changes to documentation files, if the PR contains updates to documentation. To see the preview, click on the Details link in front of the Netlify status reported (refer screenshot above).

After completing v1.1, you can adjust process rigor to suit your team's pace, as explained below.

• Reduce automated tests have benefits, but they can be a pain to write/maintain; GUI tests are especially hard to maintain because their behavior can sometimes depend on things such as the OS, resolution etc.
  It is OK to get rid of some of the troublesome tests and rely more on manual testing instead. The less automated tests you have, the higher the risk of regressions; but it may be an acceptable trade-off under the circumstances if tests are slowing you down too much.
  There is no direct penalty for removing GUI tests. Also note our expectation on test code.

• Reduce automated checks: You can also reduce the rigor of checkstyle checks to expedite PR processing.

• Switch to a lighter workflow: While forking workflow is the safest, it is also rather heavy. You an switch to a simpler workflow if the forking workflow is slowing you down. Refer the textbook to find more about alternative workflows: branching workflow, centralized workflow. However, we still recommend that you use PR reviews, at least for PRs affecting others' features.

You can also increase the rigor/safety of your workflow in the following ways:

• Use GitHub's Protected Branches feature to protect your master branch against rogue PRs.

 

• There is no requirement for a minimum coverage level. Note that in a production environment you are often required to have at least 90% of the code covered by tests. In this project, it can be less. The less coverage you have, the higher the risk of regression bugs, which will cost marks if not fixed before the final submission.
• You must write some tests so that we can evaluate your ability to write tests.
• How much of each type of testing should you do? We expect you to decide. You learned different types of testing and what they try to achieve. Based on that, you should decide how much of each type is required. Similarly, you can decide to what extent you want to automate tests, depending on the benefits and the effort required.
• Applying TDD is optional. If you plan to test something, it is better to apply TDD because TDD ensures that you write functional code in a testable way. If you do it the normal way, you often find that it is hard to test the functional code because the code has low testability.

 

Project Management → Revision Control →

Forking Flow

In the forking workflow, the 'official' version of the software is kept in a remote repo designated as the 'main repo'. All team members fork the main repo create pull requests from their fork to the main repo.

To illustrate how the workflow goes, let’s assume Jean wants to fix a bug in the code. Here are the steps:

1. Jean creates a separate branch in her local repo and fixes the bug in that branch.
2. Jean pushes the branch to her fork.
3. Jean creates a pull request from that branch in her fork to the main repo.
4. Other members review Jean’s pull request.
5. If reviewers suggested any changes, Jean updates the PR accordingly.
6. When reviewers are satisfied with the PR, one of the members (usually the team lead or a designated 'maintainer' of the main repo) merges the PR, which brings Jean’s code to the main repo.
7. Other members, realizing there is new code in the upstream repo, sync their forks with the new upstream repo (i.e. the main repo). This is done by pulling the new code to their own local repo and pushing the updated code to their own fork.

• A detailed explanation of the Forking Workflow - From Atlassian

Update UG and DG in the repo, attempt to do global-impact changes to the code base.

Milestone progress is graded. Be reminded that reaching individual and team milestones are considered for grading the project management component of your project grade.

Most aspects project progress are tracked using automated scripts. lease follow our instructions closely or else the script will not be able to detect your progress. We prefer not to spend admin resources processing requests for partial credit for work that did not follow the instructions precisely, unless the progress was not detected due to a bug in the script.

Milestone requirements are cumulative. The recommended progress for the mid-milestone is an implicit requirement for the actual milestone unless a milestone requirement overrides a mid-milestone requirement e.g., mid-milestone requires a document to be in a temp format while the actual milestone requires it to be in the proper format. Similarly, a requirement for milestone n is also an implicit requirement for milestone n+1 unless n+1 overrides the n requirement. This means if you miss some requirement at milestone n, you should try to achieve it before milestone n+1 or else it could be noted again as a 'missed requirement' at milestone n+1.

v1.1 Summary of Milestone

 

Set up project repo, start moving UG and DG to the repo, attempt to do local-impact changes to the code base.

Project Management:

Set up the team org and the team repo as explained below:

Relevant: [Admin Appendix E(extract): Organization setup ]

 

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 : CS2103-AY1819S1-TEAM_ID. e.g.  CS2103-AY1819S1-W12-1
  • Plan:  Open Source ($0/month)
• Add members to the organization:
  • Create a team called developers to your organization.
  • Add your team members to the developers team.

Relevant: [Admin Appendix E(extract): Repo setup ]

 

Repo setup

Only one team member:

1. Fork Address Book Level 4 to your team org.
2. Rename the forked repo as main. This repo (let's call it the team repo) is to be used as the repo for your project.
3. Ensure the issue tracker of your team repo is enabled. Reason: our bots will be posting your weekly progress reports on the issue tracker of your team repo.
4. Ensure your team members have the desired level of access to your team repo.
5. Enable Travis CI for the team repo.
6. Set up auto-publishing of docs. When set up correctly, your project website should be available via the URL https://nus-cs2103-ay1819s1-{team-id}.github.io/main e.g., https://cs2103-ay1819s1-w13-1.github.io/main/. This also requires you to enable the GitHub Pages feature of your team repo and configure it to serve the website from the gh-pages branch.
7. create a team PR for us to track your project progress: i.e., create a PR from your team repo master branch to [nus-cs2103-AY1819S1/addressbook-level4] master branch. PR name: [Team ID] Product Name e.g., [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 @mention the other team members so that they get notified when the tutor adds comments to the PR.

All team members:

1. Watchthe main 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 main repo to your personal GitHub account.
3. Clone the fork to your Computer.
4. Recommended: Set it up as an Intellij project (follow the instructions in the Developer Guide carefully).
5. Set up the developer environment in your computer. You are recommended to use JDK 9 for AB-4 as some of the libraries used in AB-4 have not updated to support Java 10 yet. JDK 9 can be downloaded from the Java Archive.

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

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

When updating code in the repo, follow the workflow explained below:

Relevant: [Admin Appendix E(extract): Workflow ]

 

Workflow

Before you do any coding for the project,

• Ensure you have set the Git username correctly (as explained in Appendix E) in all Computers you use for coding.
• Read our reuse policy (in Admin: Appendix B), in particular, how to give credit when you reuse code from the Internet or classmates:

 

Setting Git Username to Match GitHub Username

We use various tools to analyze your code. For us to be able to identify your commits, you should use the GitHub username as your Git username as well. If there is a mismatch, or if you use multiple user names for Git, our tools might miss some of your work and as a result you might not get credit for some of your work.

In each Computer you use for coding, after installing Git, you should set the Git username as follows.

1. Open a command window that can run Git commands (e.g., Git bash window)
2. Run the command git config --global user.name YOUR_GITHUB_USERNAME
   e.g., git config --global user.name JohnDoe

More info about setting Git username is here.

 

Policy on reuse

Reuse is encouraged. However, note that reuse has its own costs (such as the learning curve, additional complexity, usage restrictions, and unknown bugs). Furthermore, you will not be given credit for work done by others. Rather, you will be given credit for using work done by others.

• You are allowed to reuse work from your classmates, subject to following conditions:
  • The work has been published by us or the authors.
  • You clearly give credit to the original author(s).
• You are allowed to reuse work from external sources, subject to following conditions:
  • The work comes from a source of 'good standing' (such as an established open source project). This means you cannot reuse code written by an outside 'friend'.
  • You clearly give credit to the original author. Acknowledge use of third party resources clearly e.g. in the welcome message, splash screen (if any) or under the 'about' menu. If you are open about reuse, you are less likely to get into trouble if you unintentionally reused something copyrighted.
  • You do not violate the license under which the work has been released. Please  do not use 3rd-party images/audio in your software unless they have been specifically released to be used freely. Just because you found it in the Internet does not mean it is free for reuse.
  • Always get permission from us before you reuse third-party libraries. Please post your 'request to use 3rd party library' in our forum. That way, the whole class get to see what libraries are being used by others.

Giving credit for reused work

Given below are how to give credit for things you reuse from elsewhere. These requirements are specific to this module  i.e., not applicable outside the module (outside the module you should follow the rules specified by your employer and the license of the reused work)

If you used a third party library:

• Mention in the README.adoc (under the Acknowledgements section)
• mention in the Project Portfolio Page if the library has a significant relevance to the features you implemented

If you reused code snippets found on the Internet  e.g. from StackOverflow answers or
referred code in another software or
referred project code by current/past student:

• If you read the code to understand the approach and implemented it yourself, mention it as a comment
  Example:

  //Solution below adapted from https://stackoverflow.com/a/16252290
  {Your implmentation of the reused solution here ...}
  

• If you copy-pasted a non-trivial code block (possibly with minor modifications  renaming, layout changes, changes to comments, etc.), also mark the code block as reused code (using @@author tags)
  Format:

  //@@author {yourGithubUsername}-reused
  //{Info about the source...}
  
  {Reused code (possibly with minor modifications) here ...}
  
  //@@author
  

  Example of reusing a code snippet (with minor modifications):

  persons = getList()
  //@@author johndoe-reused
  //Reused from https://stackoverflow.com/a/34646172 with minor modifications
  Collections.sort(persons, new Comparator<CustomData>() {
      @Override
      public int compare(CustomData lhs, CustomData rhs) {
          return lhs.customInt > rhs.customInt ? -1 : (lhs.customInt < rhs.customInt) ? 1 : 0;
      }
  });
  //@@author
  return persons;
  

 

Adding @@author tags indicate authorship

• Mark your code with a //@@author {yourGithubUsername}. Note the double @.
  The //@@author tag should indicates the beginning of the code you wrote. The code up to the next //@@author tag or the end of the file (whichever comes first) will be considered as was written by that author. Here is a sample code file:

  //@@author johndoe
  method 1 ...
  method 2 ...
  //@@author sarahkhoo
  method 3 ...
  //@@author johndoe
  method 4 ...
  

• If you don't know who wrote the code segment below yours, you may put an empty //@@author (i.e. no GitHub username) to indicate the end of the code segment you wrote. The author of code below yours can add the GitHub username to the empty tag later. Here is a sample code with an empty author tag:

  method 0 ...
  //@@author johndoe
  method 1 ...
  method 2 ...
  //@@author
  method 3 ...
  method 4 ...
  

• The author tag syntax varies based on file type e.g. for java, css, fxml. Use the corresponding comment syntax for non-Java files.
  Here is an example code from an xml/fxml file.

  <!-- @@author sereneWong -->
  <textbox>
    <label>...</label>
    <input>...</input>
  </textbox>
  ...
  

• Do not put the //@@author inside java header comments.
  👎

  /**
    * Returns true if ...
    * @@author johndoe
    */
  

  👍

  //@@author johndoe
  /**
    * Returns true if ...
    */
  

What to and what not to annotate

• Annotate both functional and test code There is no need to annotate documentation files.

• Annotate only significant size code blocks that can be reviewed on its own  e.g., a class, a sequence of methods, a method.
  Claiming credit for code blocks smaller than a method is discouraged but allowed. If you do, do it sparingly and only claim meaningful blocks of code such as a block of statements, a loop, or an if-else statement.

  • If an enhancement required you to do tiny changes in many places, there is no need to annotate all those tiny changes; you can describe those changes in the Project Portfolio page instead.
  • If a code block was touched by more than one person, either let the person who wrote most of it (e.g. more than 80%) take credit for the entire block, or leave it as 'unclaimed' (i.e., no author tags).
  • Related to the above point, if you claim a code block as your own, more than 80% of the code in that block should have been written by yourself. For example, no more than 20% of it can be code you reused from somewhere.
  • 💡 GitHub has a blame feature and a history feature that can help you determine who wrote a piece of code.

• Do not try to boost the quantity of your contribution using unethical means such as duplicating the same code in multiple places. In particular, do not copy-paste test cases to create redundant tests. Even repetitive code blocks within test methods should be extracted out as utility methods to reduce code duplication. Individual members are responsible for making sure code attributed to them are correct. If you notice a team member claiming credit for code that he/she did not write or use other questionable tactics, you can email us (after the final submission) to let us know.

• If you wrote a significant amount of code that was not used in the final product,

  • Create a folder called {project root}/unused
  • Move unused files (or copies of files containing unused code) to that folder
  • use //@@author {yourGithubUsername}-unused to mark unused code in those files (note the suffix unused) e.g.

  //@@author johndoe-unused
  method 1 ...
  method 2 ...
  

  Please put a comment in the code to explain why it was not used.

• If you reused code from elsewhere, mark such code as //@@author {yourGithubUsername}-reused (note the suffix reused) e.g.

  //@@author johndoe-reused
  method 1 ...
  method 2 ...
  

• You can use empty @@author tags to mark code as not yours when RepoSense attribute the to you incorrectly.

  • Code generated by the IDE/framework, should not be annotated as your own.

  • Code you modified in minor ways e.g. adding a parameter. These should not be claimed as yours but you can mention these additional contributions in the Project Portfolio page if you want to claim credit for them.

 

At the end of the project each student is required to submit a Project Portfolio Page.

• Objective:

  • For you to use  (e.g. in your resume) as a well-documented data point of your SE experience
  • For us to use as a data point to evaluate your,
    • contributions to the project
    • your documentation skills

• Sections to include:

  • Overview: A short overview of your product to provide some context to the reader.

  • Summary of Contributions:

    • Code contributed: Give a link to your code on Project Code Dashboard, which should be https://nus-cs2103-ay1819s1.github.io/cs2103-dashboard/#=undefined&search=githbub_username_in_lower_case (replace githbub_username_in_lower_case with your actual username in lower case e.g., johndoe). This link is also available in the Project List Page -- linked to the icon under your photo.
    • Main feature implemented: A summary of the main feature (the so called major enhancement) you implemented
    • Other contributions:
      • Other minor enhancements you did which are not related to your main feature
      • Contributions to project management e.g., setting up project tools, managing releases, managing issue tracker etc.
      • Evidence of helping others e.g. responses you posted in our forum, bugs you reported in other team's products,
      • Evidence of technical leadership e.g. sharing useful information in the forum

  • Contributions to the User Guide: Reproduce the parts in the User Guide that you wrote. This can include features you implemented as well as features you propose to implement.
    The purpose of allowing you to include proposed features is to provide you more flexibility to show your documentation skills. e.g. you can bring in a proposed feature just to give you an opportunity to use a UML diagram type not used by the actual features.

  • Contributions to the Developer Guide: Reproduce the parts in the Developer Guide that you wrote. Ensure there is enough content to evaluate your technical documentation skills and UML modelling skills. You can include descriptions of your design/implementations, possible alternatives, pros and cons of alternatives, etc.

  • If you plan to use the PPP in your Resume, you can also include your SE work outside of the module (will not be graded)

• Format:

  • File name: docs/team/githbub_username_in_lower_case.adoc e.g., docs/team/johndoe.adoc

  • Follow the example in the AddressBook-Level4, but ignore the following two lines in it.
    

    • Minor enhancement: added a history command that allows the user to navigate to previous commands using up/down keys.
    • Code contributed: [Functional code] [Test code] {give links to collated code files}

  • 💡 You can use the Asciidoc's include feature to include sections from the developer guide or the user guide in your PPP. Follow the example in the sample.

  • It is assumed that all contents in the PPP were written primarily by you. If any section is written by someone else  e.g. someone else wrote described the feature in the User Guide but you implemented the feature, clearly state that the section was written by someone else  (e.g. Start of Extract [from: User Guide] written by Jane Doe).  Reason: Your writing skills will be evaluated based on the PPP

  • Page limit: If you have more content than the limit given below, shorten (or omit some content) so that you do not exceed the page limit. Having too much content in the PPP will be viewed unfavorably during grading. Note: the page limits given below are after converting to PDF format. The actual amount of content you require is actually less than what these numbers suggest because the HTML → PDF conversion adds a lot of spacing around content.

    Content	Limit
    Overview + Summary of contributions	0.5-1
    Contributions to the User Guide	1-3
    Contributions to the Developer Guide	3-6
    Total	5-10

Follow the forking workflow in your project up to v1.1. In particular,

• Get team members to review PRs. A workflow without PR reviews is a risky workflow.
• Do not merge PRs failing CI. After setting up Travis, the CI status of a PR is reported at the bottom of the PR page. The screenshot below shows the status of a PR that is passing all CI checks.
  
  If there is a failure, you can click on the Details link in corresponding line to find out more about the failure. Once you figure out the cause of the failure, push the a fix to the PR.
• After setting up Netlify, you can use Netlify PR Preview to preview changes to documentation files, if the PR contains updates to documentation. To see the preview, click on the Details link in front of the Netlify status reported (refer screenshot above).

After completing v1.1, you can adjust process rigor to suit your team's pace, as explained below.

• Reduce automated tests have benefits, but they can be a pain to write/maintain; GUI tests are especially hard to maintain because their behavior can sometimes depend on things such as the OS, resolution etc.
  It is OK to get rid of some of the troublesome tests and rely more on manual testing instead. The less automated tests you have, the higher the risk of regressions; but it may be an acceptable trade-off under the circumstances if tests are slowing you down too much.
  There is no direct penalty for removing GUI tests. Also note our expectation on test code.

• Reduce automated checks: You can also reduce the rigor of checkstyle checks to expedite PR processing.

• Switch to a lighter workflow: While forking workflow is the safest, it is also rather heavy. You an switch to a simpler workflow if the forking workflow is slowing you down. Refer the textbook to find more about alternative workflows: branching workflow, centralized workflow. However, we still recommend that you use PR reviews, at least for PRs affecting others' features.

You can also increase the rigor/safety of your workflow in the following ways:

• Use GitHub's Protected Branches feature to protect your master branch against rogue PRs.

 

• There is no requirement for a minimum coverage level. Note that in a production environment you are often required to have at least 90% of the code covered by tests. In this project, it can be less. The less coverage you have, the higher the risk of regression bugs, which will cost marks if not fixed before the final submission.
• You must write some tests so that we can evaluate your ability to write tests.
• How much of each type of testing should you do? We expect you to decide. You learned different types of testing and what they try to achieve. Based on that, you should decide how much of each type is required. Similarly, you can decide to what extent you want to automate tests, depending on the benefits and the effort required.
• Applying TDD is optional. If you plan to test something, it is better to apply TDD because TDD ensures that you write functional code in a testable way. If you do it the normal way, you often find that it is hard to test the functional code because the code has low testability.

 

Project Management → Revision Control →

Forking Flow

In the forking workflow, the 'official' version of the software is kept in a remote repo designated as the 'main repo'. All team members fork the main repo create pull requests from their fork to the main repo.

To illustrate how the workflow goes, let’s assume Jean wants to fix a bug in the code. Here are the steps:

1. Jean creates a separate branch in her local repo and fixes the bug in that branch.
2. Jean pushes the branch to her fork.
3. Jean creates a pull request from that branch in her fork to the main repo.
4. Other members review Jean’s pull request.
5. If reviewers suggested any changes, Jean updates the PR accordingly.
6. When reviewers are satisfied with the PR, one of the members (usually the team lead or a designated 'maintainer' of the main repo) merges the PR, which brings Jean’s code to the main repo.
7. Other members, realizing there is new code in the upstream repo, sync their forks with the new upstream repo (i.e. the main repo). This is done by pulling the new code to their own local repo and pushing the updated code to their own fork.

• A detailed explanation of the Forking Workflow - From Atlassian

Documentation:

Recommended procedure for updating docs:

1. Divide among yourselves who will update which parts of the document(s).
2. Update the team repo by following the workflow mentioned above.

Update the following pages in your project repo:

• About Us page: This page is used for module admin purposes. Please follow the format closely or else our scripts will not be able to give credit for your work.
  • Replace info of SE-EDU developers with info of your team, including a suitable photo as described here.
  • Including the name/photo of the supervisor/lecturer is optional.
  • The photo of a team member should be doc/images/githbub_username_in_lower_case.png e.g. docs/images/damithc.png. If you photo is in jpg format, name the file as .png anyway.
  • Indicate the different roles played and responsibilities held by each team member. You can reassign these roles and responsibilities (as explained in Admin Project Scope) later in the project, if necessary.

 

• The purpose of the profile photo is for the teaching team to identify you. Therefore, you should choose a recent individual photo showing your face clearly (i.e., not too small) -- somewhat similar to a passport photo. Some examples can be seen in the 'Teaching team' page. Given below are some examples of good and bad profile photos.
  

• If you are uncomfortable posting your photo due to security reasons, you can post a lower resolution image so that it is hard for someone to misuse that image for fraudulent purposes. If you are concerned about privacy, you can request permission to omit your photo from the page by writing to prof.

 

Roles indicate aspects you are in charge of and responsible for. E.g., if you are in charge of documentation, you are the person who should allocate which parts of the documentation is to be done by who, ensure the document is in right format, ensure consistency etc.

This is a non-exhaustive list; you may define additional roles.

• Team lead: Responsible for overall project coordination.
• Documentation (short for ‘in charge of documentation’): Responsible for the quality of various project documents.
• Testing: Ensures the testing of the project is done properly and on time.
• Code quality: Looks after code quality, ensures adherence to coding standards, etc.
• Deliverables and deadlines: Ensure project deliverables are done on time and in the right format.
• Integration: In charge of versioning of the code, maintaining the code repository, integrating various parts of the software to create a whole.
• Scheduling and tracking: In charge of defining, assigning, and tracking project tasks.
• [Tool ABC] expert: e.g. Intellij expert, Git expert, etc. Helps other team member with matters related to the specific tool.
• In charge of[Component XYZ]: e.g. In charge of Model, UI, Storage, etc. If you are in charge of a component, you are expected to know that component well, and review changes done to that component in v1.3-v1.4.

Please make sure each of the important roles are assigned to one person in the team. It is OK to have a 'backup' for each role, but for each aspect there should be one person who is unequivocally the person responsible for it.

• Contact Us Page: Update to match your product.

• README.adoc page: Update it to match your project.

  • Add a UI mockup of your intended final product.
    Note that the image of the UI should be docs/images/Ui.png so that it can be downloaded by our scripts. Limit the file to contain one screenshot/mockup only and ensure the new image is roughly the same height x width proportions as the original one. Reason: when we compile these images from all teams into one page (example), yours should not look out of place.

  • The original README.adoc file (which doubles as the landing page of your project website) is written to read like the introduction to an SE learning/teaching resource. You should restructure this page to look like the home page of a real product (not a school project) targeting real users  e.g. remove references to addressbook-level3, Learning Outcomes etc. mention target users, add a marketing blurb etc. On a related note, also remove Learning Outcomes link and related pages.

  • Update the link of the Travis build status badge () so that it reflects the build status of your team repo.
    For the other badges,

    • either set up the respective tool for your project (AB-4 Developer Guide has instructions on how to set up AppVeyor and Coveralls) and update the badges accordingly,
    • or remove the badge.

  • Acknowledge the original source of the code i.e. AddressBook-Level4 project created by SE-EDU initiative at https://github.com/se-edu/

• User Guide: Start moving the content from your User Guide (draft created in previous weeks) into the User Guide page in your repository. If a feature is not implemented, mark it as 'Coming in v2.0' (example).

• Developer Guide: Similar to the User Guide, start moving the content from your Developer Guide (draft created in previous weeks) into the Developer Guide page in your team repository.

Product:

• Each member can attempt to do a local-impact change to the code base.

  Objective: To familiarize yourself with at least one components of the product.

  Description: Divide the components among yourselves. Each member can do some small enhancements to their component(s) to learn the code of that component. Some suggested enhancements are given in the AddressBook-Level4 developer guide.

  Submission: Create PRs from your own fork to your team repo. Get it merged by following your team's workflow.

v1.1 Project Management

• Fix any errors in org/repo set up  (e.g. wrong repo name).
• Wrap up the milestone using a git tag v1.1 as explained below:
  • When the milestone deadline is near (e.g., 0.5 days before the deadline), if you think some of the ongoing work intended for the current milestone may not finish in time, reassign them to a future milestone.
  • After all changes that can be merged before the milestone deadline has been merged, use git tag feature to tag the current version with the milestone and push the tag to the team repo.

v1.1 Documentation

• Update User Guide, Developer Guide, README, and About Us pages as described earlier in mid-v1.1 progress guide.

  Submission: merge your changes to the master branch of your repo.

 

Set up project repo, start moving UG and DG to the repo, attempt to do local-impact changes to the code base.

Project Management:

Set up the team org and the team repo as explained below:

Relevant: [Admin Appendix E(extract): Organization setup ]

 

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 : CS2103-AY1819S1-TEAM_ID. e.g.  CS2103-AY1819S1-W12-1
  • Plan:  Open Source ($0/month)
• Add members to the organization:
  • Create a team called developers to your organization.
  • Add your team members to the developers team.

Relevant: [Admin Appendix E(extract): Repo setup ]

 

Repo setup

Only one team member:

1. Fork Address Book Level 4 to your team org.
2. Rename the forked repo as main. This repo (let's call it the team repo) is to be used as the repo for your project.
3. Ensure the issue tracker of your team repo is enabled. Reason: our bots will be posting your weekly progress reports on the issue tracker of your team repo.
4. Ensure your team members have the desired level of access to your team repo.
5. Enable Travis CI for the team repo.
6. Set up auto-publishing of docs. When set up correctly, your project website should be available via the URL https://nus-cs2103-ay1819s1-{team-id}.github.io/main e.g., https://cs2103-ay1819s1-w13-1.github.io/main/. This also requires you to enable the GitHub Pages feature of your team repo and configure it to serve the website from the gh-pages branch.
7. create a team PR for us to track your project progress: i.e., create a PR from your team repo master branch to [nus-cs2103-AY1819S1/addressbook-level4] master branch. PR name: [Team ID] Product Name e.g., [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 @mention the other team members so that they get notified when the tutor adds comments to the PR.

All team members:

1. Watchthe main 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 main repo to your personal GitHub account.
3. Clone the fork to your Computer.
4. Recommended: Set it up as an Intellij project (follow the instructions in the Developer Guide carefully).
5. Set up the developer environment in your computer. You are recommended to use JDK 9 for AB-4 as some of the libraries used in AB-4 have not updated to support Java 10 yet. JDK 9 can be downloaded from the Java Archive.

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

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

When updating code in the repo, follow the workflow explained below:

Relevant: [Admin Appendix E(extract): Workflow ]

 

Workflow

Before you do any coding for the project,

• Ensure you have set the Git username correctly (as explained in Appendix E) in all Computers you use for coding.
• Read our reuse policy (in Admin: Appendix B), in particular, how to give credit when you reuse code from the Internet or classmates:

 

Setting Git Username to Match GitHub Username

We use various tools to analyze your code. For us to be able to identify your commits, you should use the GitHub username as your Git username as well. If there is a mismatch, or if you use multiple user names for Git, our tools might miss some of your work and as a result you might not get credit for some of your work.

In each Computer you use for coding, after installing Git, you should set the Git username as follows.

1. Open a command window that can run Git commands (e.g., Git bash window)
2. Run the command git config --global user.name YOUR_GITHUB_USERNAME
   e.g., git config --global user.name JohnDoe

More info about setting Git username is here.

 

Policy on reuse

Reuse is encouraged. However, note that reuse has its own costs (such as the learning curve, additional complexity, usage restrictions, and unknown bugs). Furthermore, you will not be given credit for work done by others. Rather, you will be given credit for using work done by others.

• You are allowed to reuse work from your classmates, subject to following conditions:
  • The work has been published by us or the authors.
  • You clearly give credit to the original author(s).
• You are allowed to reuse work from external sources, subject to following conditions:
  • The work comes from a source of 'good standing' (such as an established open source project). This means you cannot reuse code written by an outside 'friend'.
  • You clearly give credit to the original author. Acknowledge use of third party resources clearly e.g. in the welcome message, splash screen (if any) or under the 'about' menu. If you are open about reuse, you are less likely to get into trouble if you unintentionally reused something copyrighted.
  • You do not violate the license under which the work has been released. Please  do not use 3rd-party images/audio in your software unless they have been specifically released to be used freely. Just because you found it in the Internet does not mean it is free for reuse.
  • Always get permission from us before you reuse third-party libraries. Please post your 'request to use 3rd party library' in our forum. That way, the whole class get to see what libraries are being used by others.

Giving credit for reused work

Given below are how to give credit for things you reuse from elsewhere. These requirements are specific to this module  i.e., not applicable outside the module (outside the module you should follow the rules specified by your employer and the license of the reused work)

If you used a third party library:

• Mention in the README.adoc (under the Acknowledgements section)
• mention in the Project Portfolio Page if the library has a significant relevance to the features you implemented

If you reused code snippets found on the Internet  e.g. from StackOverflow answers or
referred code in another software or
referred project code by current/past student:

• If you read the code to understand the approach and implemented it yourself, mention it as a comment
  Example:

  //Solution below adapted from https://stackoverflow.com/a/16252290
  {Your implmentation of the reused solution here ...}
  

• If you copy-pasted a non-trivial code block (possibly with minor modifications  renaming, layout changes, changes to comments, etc.), also mark the code block as reused code (using @@author tags)
  Format:

  //@@author {yourGithubUsername}-reused
  //{Info about the source...}
  
  {Reused code (possibly with minor modifications) here ...}
  
  //@@author
  

  Example of reusing a code snippet (with minor modifications):

  persons = getList()
  //@@author johndoe-reused
  //Reused from https://stackoverflow.com/a/34646172 with minor modifications
  Collections.sort(persons, new Comparator<CustomData>() {
      @Override
      public int compare(CustomData lhs, CustomData rhs) {
          return lhs.customInt > rhs.customInt ? -1 : (lhs.customInt < rhs.customInt) ? 1 : 0;
      }
  });
  //@@author
  return persons;
  

 

Adding @@author tags indicate authorship

• Mark your code with a //@@author {yourGithubUsername}. Note the double @.
  The //@@author tag should indicates the beginning of the code you wrote. The code up to the next //@@author tag or the end of the file (whichever comes first) will be considered as was written by that author. Here is a sample code file:

  //@@author johndoe
  method 1 ...
  method 2 ...
  //@@author sarahkhoo
  method 3 ...
  //@@author johndoe
  method 4 ...
  

• If you don't know who wrote the code segment below yours, you may put an empty //@@author (i.e. no GitHub username) to indicate the end of the code segment you wrote. The author of code below yours can add the GitHub username to the empty tag later. Here is a sample code with an empty author tag:

  method 0 ...
  //@@author johndoe
  method 1 ...
  method 2 ...
  //@@author
  method 3 ...
  method 4 ...
  

• The author tag syntax varies based on file type e.g. for java, css, fxml. Use the corresponding comment syntax for non-Java files.
  Here is an example code from an xml/fxml file.

  <!-- @@author sereneWong -->
  <textbox>
    <label>...</label>
    <input>...</input>
  </textbox>
  ...
  

• Do not put the //@@author inside java header comments.
  👎

  /**
    * Returns true if ...
    * @@author johndoe
    */
  

  👍

  //@@author johndoe
  /**
    * Returns true if ...
    */
  

What to and what not to annotate

• Annotate both functional and test code There is no need to annotate documentation files.

• Annotate only significant size code blocks that can be reviewed on its own  e.g., a class, a sequence of methods, a method.
  Claiming credit for code blocks smaller than a method is discouraged but allowed. If you do, do it sparingly and only claim meaningful blocks of code such as a block of statements, a loop, or an if-else statement.

  • If an enhancement required you to do tiny changes in many places, there is no need to annotate all those tiny changes; you can describe those changes in the Project Portfolio page instead.
  • If a code block was touched by more than one person, either let the person who wrote most of it (e.g. more than 80%) take credit for the entire block, or leave it as 'unclaimed' (i.e., no author tags).
  • Related to the above point, if you claim a code block as your own, more than 80% of the code in that block should have been written by yourself. For example, no more than 20% of it can be code you reused from somewhere.
  • 💡 GitHub has a blame feature and a history feature that can help you determine who wrote a piece of code.

• Do not try to boost the quantity of your contribution using unethical means such as duplicating the same code in multiple places. In particular, do not copy-paste test cases to create redundant tests. Even repetitive code blocks within test methods should be extracted out as utility methods to reduce code duplication. Individual members are responsible for making sure code attributed to them are correct. If you notice a team member claiming credit for code that he/she did not write or use other questionable tactics, you can email us (after the final submission) to let us know.

• If you wrote a significant amount of code that was not used in the final product,

  • Create a folder called {project root}/unused
  • Move unused files (or copies of files containing unused code) to that folder
  • use //@@author {yourGithubUsername}-unused to mark unused code in those files (note the suffix unused) e.g.

  //@@author johndoe-unused
  method 1 ...
  method 2 ...
  

  Please put a comment in the code to explain why it was not used.

• If you reused code from elsewhere, mark such code as //@@author {yourGithubUsername}-reused (note the suffix reused) e.g.

  //@@author johndoe-reused
  method 1 ...
  method 2 ...
  

• You can use empty @@author tags to mark code as not yours when RepoSense attribute the to you incorrectly.

  • Code generated by the IDE/framework, should not be annotated as your own.

  • Code you modified in minor ways e.g. adding a parameter. These should not be claimed as yours but you can mention these additional contributions in the Project Portfolio page if you want to claim credit for them.

 

At the end of the project each student is required to submit a Project Portfolio Page.

• Objective:

  • For you to use  (e.g. in your resume) as a well-documented data point of your SE experience
  • For us to use as a data point to evaluate your,
    • contributions to the project
    • your documentation skills

• Sections to include:

  • Overview: A short overview of your product to provide some context to the reader.

  • Summary of Contributions:

    • Code contributed: Give a link to your code on Project Code Dashboard, which should be https://nus-cs2103-ay1819s1.github.io/cs2103-dashboard/#=undefined&search=githbub_username_in_lower_case (replace githbub_username_in_lower_case with your actual username in lower case e.g., johndoe). This link is also available in the Project List Page -- linked to the icon under your photo.
    • Main feature implemented: A summary of the main feature (the so called major enhancement) you implemented
    • Other contributions:
      • Other minor enhancements you did which are not related to your main feature
      • Contributions to project management e.g., setting up project tools, managing releases, managing issue tracker etc.
      • Evidence of helping others e.g. responses you posted in our forum, bugs you reported in other team's products,
      • Evidence of technical leadership e.g. sharing useful information in the forum

  • Contributions to the User Guide: Reproduce the parts in the User Guide that you wrote. This can include features you implemented as well as features you propose to implement.
    The purpose of allowing you to include proposed features is to provide you more flexibility to show your documentation skills. e.g. you can bring in a proposed feature just to give you an opportunity to use a UML diagram type not used by the actual features.

  • Contributions to the Developer Guide: Reproduce the parts in the Developer Guide that you wrote. Ensure there is enough content to evaluate your technical documentation skills and UML modelling skills. You can include descriptions of your design/implementations, possible alternatives, pros and cons of alternatives, etc.

  • If you plan to use the PPP in your Resume, you can also include your SE work outside of the module (will not be graded)

• Format:

  • File name: docs/team/githbub_username_in_lower_case.adoc e.g., docs/team/johndoe.adoc

  • Follow the example in the AddressBook-Level4, but ignore the following two lines in it.
    

    • Minor enhancement: added a history command that allows the user to navigate to previous commands using up/down keys.
    • Code contributed: [Functional code] [Test code] {give links to collated code files}

  • 💡 You can use the Asciidoc's include feature to include sections from the developer guide or the user guide in your PPP. Follow the example in the sample.

  • It is assumed that all contents in the PPP were written primarily by you. If any section is written by someone else  e.g. someone else wrote described the feature in the User Guide but you implemented the feature, clearly state that the section was written by someone else  (e.g. Start of Extract [from: User Guide] written by Jane Doe).  Reason: Your writing skills will be evaluated based on the PPP

  • Page limit: If you have more content than the limit given below, shorten (or omit some content) so that you do not exceed the page limit. Having too much content in the PPP will be viewed unfavorably during grading. Note: the page limits given below are after converting to PDF format. The actual amount of content you require is actually less than what these numbers suggest because the HTML → PDF conversion adds a lot of spacing around content.

    Content	Limit
    Overview + Summary of contributions	0.5-1
    Contributions to the User Guide	1-3
    Contributions to the Developer Guide	3-6
    Total	5-10

Follow the forking workflow in your project up to v1.1. In particular,

• Get team members to review PRs. A workflow without PR reviews is a risky workflow.
• Do not merge PRs failing CI. After setting up Travis, the CI status of a PR is reported at the bottom of the PR page. The screenshot below shows the status of a PR that is passing all CI checks.
  
  If there is a failure, you can click on the Details link in corresponding line to find out more about the failure. Once you figure out the cause of the failure, push the a fix to the PR.
• After setting up Netlify, you can use Netlify PR Preview to preview changes to documentation files, if the PR contains updates to documentation. To see the preview, click on the Details link in front of the Netlify status reported (refer screenshot above).

After completing v1.1, you can adjust process rigor to suit your team's pace, as explained below.

• Reduce automated tests have benefits, but they can be a pain to write/maintain; GUI tests are especially hard to maintain because their behavior can sometimes depend on things such as the OS, resolution etc.
  It is OK to get rid of some of the troublesome tests and rely more on manual testing instead. The less automated tests you have, the higher the risk of regressions; but it may be an acceptable trade-off under the circumstances if tests are slowing you down too much.
  There is no direct penalty for removing GUI tests. Also note our expectation on test code.

• Reduce automated checks: You can also reduce the rigor of checkstyle checks to expedite PR processing.

• Switch to a lighter workflow: While forking workflow is the safest, it is also rather heavy. You an switch to a simpler workflow if the forking workflow is slowing you down. Refer the textbook to find more about alternative workflows: branching workflow, centralized workflow. However, we still recommend that you use PR reviews, at least for PRs affecting others' features.

You can also increase the rigor/safety of your workflow in the following ways:

• Use GitHub's Protected Branches feature to protect your master branch against rogue PRs.

 

• There is no requirement for a minimum coverage level. Note that in a production environment you are often required to have at least 90% of the code covered by tests. In this project, it can be less. The less coverage you have, the higher the risk of regression bugs, which will cost marks if not fixed before the final submission.
• You must write some tests so that we can evaluate your ability to write tests.
• How much of each type of testing should you do? We expect you to decide. You learned different types of testing and what they try to achieve. Based on that, you should decide how much of each type is required. Similarly, you can decide to what extent you want to automate tests, depending on the benefits and the effort required.
• Applying TDD is optional. If you plan to test something, it is better to apply TDD because TDD ensures that you write functional code in a testable way. If you do it the normal way, you often find that it is hard to test the functional code because the code has low testability.

 

Project Management → Revision Control →

Forking Flow

In the forking workflow, the 'official' version of the software is kept in a remote repo designated as the 'main repo'. All team members fork the main repo create pull requests from their fork to the main repo.

To illustrate how the workflow goes, let’s assume Jean wants to fix a bug in the code. Here are the steps:

1. Jean creates a separate branch in her local repo and fixes the bug in that branch.
2. Jean pushes the branch to her fork.
3. Jean creates a pull request from that branch in her fork to the main repo.
4. Other members review Jean’s pull request.
5. If reviewers suggested any changes, Jean updates the PR accordingly.
6. When reviewers are satisfied with the PR, one of the members (usually the team lead or a designated 'maintainer' of the main repo) merges the PR, which brings Jean’s code to the main repo.
7. Other members, realizing there is new code in the upstream repo, sync their forks with the new upstream repo (i.e. the main repo). This is done by pulling the new code to their own local repo and pushing the updated code to their own fork.

• A detailed explanation of the Forking Workflow - From Atlassian

Documentation:

Recommended procedure for updating docs:

1. Divide among yourselves who will update which parts of the document(s).
2. Update the team repo by following the workflow mentioned above.

Update the following pages in your project repo:

• About Us page: This page is used for module admin purposes. Please follow the format closely or else our scripts will not be able to give credit for your work.
  • Replace info of SE-EDU developers with info of your team, including a suitable photo as described here.
  • Including the name/photo of the supervisor/lecturer is optional.
  • The photo of a team member should be doc/images/githbub_username_in_lower_case.png e.g. docs/images/damithc.png. If you photo is in jpg format, name the file as .png anyway.
  • Indicate the different roles played and responsibilities held by each team member. You can reassign these roles and responsibilities (as explained in Admin Project Scope) later in the project, if necessary.

 

• The purpose of the profile photo is for the teaching team to identify you. Therefore, you should choose a recent individual photo showing your face clearly (i.e., not too small) -- somewhat similar to a passport photo. Some examples can be seen in the 'Teaching team' page. Given below are some examples of good and bad profile photos.
  

• If you are uncomfortable posting your photo due to security reasons, you can post a lower resolution image so that it is hard for someone to misuse that image for fraudulent purposes. If you are concerned about privacy, you can request permission to omit your photo from the page by writing to prof.

 

Roles indicate aspects you are in charge of and responsible for. E.g., if you are in charge of documentation, you are the person who should allocate which parts of the documentation is to be done by who, ensure the document is in right format, ensure consistency etc.

This is a non-exhaustive list; you may define additional roles.

• Team lead: Responsible for overall project coordination.
• Documentation (short for ‘in charge of documentation’): Responsible for the quality of various project documents.
• Testing: Ensures the testing of the project is done properly and on time.
• Code quality: Looks after code quality, ensures adherence to coding standards, etc.
• Deliverables and deadlines: Ensure project deliverables are done on time and in the right format.
• Integration: In charge of versioning of the code, maintaining the code repository, integrating various parts of the software to create a whole.
• Scheduling and tracking: In charge of defining, assigning, and tracking project tasks.
• [Tool ABC] expert: e.g. Intellij expert, Git expert, etc. Helps other team member with matters related to the specific tool.
• In charge of[Component XYZ]: e.g. In charge of Model, UI, Storage, etc. If you are in charge of a component, you are expected to know that component well, and review changes done to that component in v1.3-v1.4.

Please make sure each of the important roles are assigned to one person in the team. It is OK to have a 'backup' for each role, but for each aspect there should be one person who is unequivocally the person responsible for it.

• Contact Us Page: Update to match your product.

• README.adoc page: Update it to match your project.

  • Add a UI mockup of your intended final product.
    Note that the image of the UI should be docs/images/Ui.png so that it can be downloaded by our scripts. Limit the file to contain one screenshot/mockup only and ensure the new image is roughly the same height x width proportions as the original one. Reason: when we compile these images from all teams into one page (example), yours should not look out of place.

  • The original README.adoc file (which doubles as the landing page of your project website) is written to read like the introduction to an SE learning/teaching resource. You should restructure this page to look like the home page of a real product (not a school project) targeting real users  e.g. remove references to addressbook-level3, Learning Outcomes etc. mention target users, add a marketing blurb etc. On a related note, also remove Learning Outcomes link and related pages.

  • Update the link of the Travis build status badge () so that it reflects the build status of your team repo.
    For the other badges,

    • either set up the respective tool for your project (AB-4 Developer Guide has instructions on how to set up AppVeyor and Coveralls) and update the badges accordingly,
    • or remove the badge.

  • Acknowledge the original source of the code i.e. AddressBook-Level4 project created by SE-EDU initiative at https://github.com/se-edu/

• User Guide: Start moving the content from your User Guide (draft created in previous weeks) into the User Guide page in your repository. If a feature is not implemented, mark it as 'Coming in v2.0' (example).

• Developer Guide: Similar to the User Guide, start moving the content from your Developer Guide (draft created in previous weeks) into the Developer Guide page in your team repository.

Product:

• Each member can attempt to do a local-impact change to the code base.

  Objective: To familiarize yourself with at least one components of the product.

  Description: Divide the components among yourselves. Each member can do some small enhancements to their component(s) to learn the code of that component. Some suggested enhancements are given in the AddressBook-Level4 developer guide.

  Submission: Create PRs from your own fork to your team repo. Get it merged by following your team's workflow.

Adjust project schedule/rigor as needed, start proper milestone management.

Project Management:

• Switch to AB-3 or AB-2 if AB-4 is not working out for you.

Relevant: [Admin Project Deliverables → Notes for Those Using AB-2 or AB-3 for the Project ]

 

There is no explicit penalty for switching to a lower level AB. All projects are evaluated based on the same yardstick irrespective of on which AB it is based. As an AB is given to you as a 'free' head-start, a lower level AB gives you a shorter head-start, which means your final product is likely to be less functional than those from teams using AB-4 unless you progress faster than them. Nevertheless, you should switch to AB2/3 if you feel you can learn more from the project that way, as our goal is to maximize learning, not features.
If your team wants to stay with AB-4 but you want to switch to a lower level AB, let the us know so that we can work something out for you.

If you have opted to use AB-2 or AB-3 instead of AB-4 as the basis of your product, please note the following points:

• Set up auto-publishing of documentation similar to AB-4
• Add Project Portfolio Pages (PPP) for members, similar to the example provided in AB-4
• You can convert UG, DG, and PPP into pdf files using instructions provided in AB-4 DG
• Create an About Us page similar to AB-4 and update it as described in mid-v1.1 progress guide

 

Set up project repo, start moving UG and DG to the repo, attempt to do local-impact changes to the code base.

Project Management:

Set up the team org and the team repo as explained below:

Relevant: [Admin Appendix E(extract): Organization setup ]

 

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 : CS2103-AY1819S1-TEAM_ID. e.g.  CS2103-AY1819S1-W12-1
  • Plan:  Open Source ($0/month)
• Add members to the organization:
  • Create a team called developers to your organization.
  • Add your team members to the developers team.

Relevant: [Admin Appendix E(extract): Repo setup ]

 

Repo setup

Only one team member:

1. Fork Address Book Level 4 to your team org.
2. Rename the forked repo as main. This repo (let's call it the team repo) is to be used as the repo for your project.
3. Ensure the issue tracker of your team repo is enabled. Reason: our bots will be posting your weekly progress reports on the issue tracker of your team repo.
4. Ensure your team members have the desired level of access to your team repo.
5. Enable Travis CI for the team repo.
6. Set up auto-publishing of docs. When set up correctly, your project website should be available via the URL https://nus-cs2103-ay1819s1-{team-id}.github.io/main e.g., https://cs2103-ay1819s1-w13-1.github.io/main/. This also requires you to enable the GitHub Pages feature of your team repo and configure it to serve the website from the gh-pages branch.
7. create a team PR for us to track your project progress: i.e., create a PR from your team repo master branch to [nus-cs2103-AY1819S1/addressbook-level4] master branch. PR name: [Team ID] Product Name e.g., [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 @mention the other team members so that they get notified when the tutor adds comments to the PR.

All team members:

1. Watchthe main 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 main repo to your personal GitHub account.
3. Clone the fork to your Computer.
4. Recommended: Set it up as an Intellij project (follow the instructions in the Developer Guide carefully).
5. Set up the developer environment in your computer. You are recommended to use JDK 9 for AB-4 as some of the libraries used in AB-4 have not updated to support Java 10 yet. JDK 9 can be downloaded from the Java Archive.

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

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

When updating code in the repo, follow the workflow explained below:

Relevant: [Admin Appendix E(extract): Workflow ]

 

Workflow

Before you do any coding for the project,

• Ensure you have set the Git username correctly (as explained in Appendix E) in all Computers you use for coding.
• Read our reuse policy (in Admin: Appendix B), in particular, how to give credit when you reuse code from the Internet or classmates:

 

Setting Git Username to Match GitHub Username

We use various tools to analyze your code. For us to be able to identify your commits, you should use the GitHub username as your Git username as well. If there is a mismatch, or if you use multiple user names for Git, our tools might miss some of your work and as a result you might not get credit for some of your work.

In each Computer you use for coding, after installing Git, you should set the Git username as follows.

1. Open a command window that can run Git commands (e.g., Git bash window)
2. Run the command git config --global user.name YOUR_GITHUB_USERNAME
   e.g., git config --global user.name JohnDoe

More info about setting Git username is here.

 

Policy on reuse

Reuse is encouraged. However, note that reuse has its own costs (such as the learning curve, additional complexity, usage restrictions, and unknown bugs). Furthermore, you will not be given credit for work done by others. Rather, you will be given credit for using work done by others.

• You are allowed to reuse work from your classmates, subject to following conditions:
  • The work has been published by us or the authors.
  • You clearly give credit to the original author(s).
• You are allowed to reuse work from external sources, subject to following conditions:
  • The work comes from a source of 'good standing' (such as an established open source project). This means you cannot reuse code written by an outside 'friend'.
  • You clearly give credit to the original author. Acknowledge use of third party resources clearly e.g. in the welcome message, splash screen (if any) or under the 'about' menu. If you are open about reuse, you are less likely to get into trouble if you unintentionally reused something copyrighted.
  • You do not violate the license under which the work has been released. Please  do not use 3rd-party images/audio in your software unless they have been specifically released to be used freely. Just because you found it in the Internet does not mean it is free for reuse.
  • Always get permission from us before you reuse third-party libraries. Please post your 'request to use 3rd party library' in our forum. That way, the whole class get to see what libraries are being used by others.

Giving credit for reused work

Given below are how to give credit for things you reuse from elsewhere. These requirements are specific to this module  i.e., not applicable outside the module (outside the module you should follow the rules specified by your employer and the license of the reused work)

If you used a third party library:

• Mention in the README.adoc (under the Acknowledgements section)
• mention in the Project Portfolio Page if the library has a significant relevance to the features you implemented

If you reused code snippets found on the Internet  e.g. from StackOverflow answers or
referred code in another software or
referred project code by current/past student:

• If you read the code to understand the approach and implemented it yourself, mention it as a comment
  Example:

  //Solution below adapted from https://stackoverflow.com/a/16252290
  {Your implmentation of the reused solution here ...}
  

• If you copy-pasted a non-trivial code block (possibly with minor modifications  renaming, layout changes, changes to comments, etc.), also mark the code block as reused code (using @@author tags)
  Format:

  //@@author {yourGithubUsername}-reused
  //{Info about the source...}
  
  {Reused code (possibly with minor modifications) here ...}
  
  //@@author
  

  Example of reusing a code snippet (with minor modifications):

  persons = getList()
  //@@author johndoe-reused
  //Reused from https://stackoverflow.com/a/34646172 with minor modifications
  Collections.sort(persons, new Comparator<CustomData>() {
      @Override
      public int compare(CustomData lhs, CustomData rhs) {
          return lhs.customInt > rhs.customInt ? -1 : (lhs.customInt < rhs.customInt) ? 1 : 0;
      }
  });
  //@@author
  return persons;
  

 

Adding @@author tags indicate authorship

• Mark your code with a //@@author {yourGithubUsername}. Note the double @.
  The //@@author tag should indicates the beginning of the code you wrote. The code up to the next //@@author tag or the end of the file (whichever comes first) will be considered as was written by that author. Here is a sample code file:

  //@@author johndoe
  method 1 ...
  method 2 ...
  //@@author sarahkhoo
  method 3 ...
  //@@author johndoe
  method 4 ...
  

• If you don't know who wrote the code segment below yours, you may put an empty //@@author (i.e. no GitHub username) to indicate the end of the code segment you wrote. The author of code below yours can add the GitHub username to the empty tag later. Here is a sample code with an empty author tag:

  method 0 ...
  //@@author johndoe
  method 1 ...
  method 2 ...
  //@@author
  method 3 ...
  method 4 ...
  

• The author tag syntax varies based on file type e.g. for java, css, fxml. Use the corresponding comment syntax for non-Java files.
  Here is an example code from an xml/fxml file.

  <!-- @@author sereneWong -->
  <textbox>
    <label>...</label>
    <input>...</input>
  </textbox>
  ...
  

• Do not put the //@@author inside java header comments.
  👎

  /**
    * Returns true if ...
    * @@author johndoe
    */
  

  👍

  //@@author johndoe
  /**
    * Returns true if ...
    */
  

What to and what not to annotate

• Annotate both functional and test code There is no need to annotate documentation files.

• Annotate only significant size code blocks that can be reviewed on its own  e.g., a class, a sequence of methods, a method.
  Claiming credit for code blocks smaller than a method is discouraged but allowed. If you do, do it sparingly and only claim meaningful blocks of code such as a block of statements, a loop, or an if-else statement.

  • If an enhancement required you to do tiny changes in many places, there is no need to annotate all those tiny changes; you can describe those changes in the Project Portfolio page instead.
  • If a code block was touched by more than one person, either let the person who wrote most of it (e.g. more than 80%) take credit for the entire block, or leave it as 'unclaimed' (i.e., no author tags).
  • Related to the above point, if you claim a code block as your own, more than 80% of the code in that block should have been written by yourself. For example, no more than 20% of it can be code you reused from somewhere.
  • 💡 GitHub has a blame feature and a history feature that can help you determine who wrote a piece of code.

• Do not try to boost the quantity of your contribution using unethical means such as duplicating the same code in multiple places. In particular, do not copy-paste test cases to create redundant tests. Even repetitive code blocks within test methods should be extracted out as utility methods to reduce code duplication. Individual members are responsible for making sure code attributed to them are correct. If you notice a team member claiming credit for code that he/she did not write or use other questionable tactics, you can email us (after the final submission) to let us know.

• If you wrote a significant amount of code that was not used in the final product,

  • Create a folder called {project root}/unused
  • Move unused files (or copies of files containing unused code) to that folder
  • use //@@author {yourGithubUsername}-unused to mark unused code in those files (note the suffix unused) e.g.

  //@@author johndoe-unused
  method 1 ...
  method 2 ...
  

  Please put a comment in the code to explain why it was not used.

• If you reused code from elsewhere, mark such code as //@@author {yourGithubUsername}-reused (note the suffix reused) e.g.

  //@@author johndoe-reused
  method 1 ...
  method 2 ...
  

• You can use empty @@author tags to mark code as not yours when RepoSense attribute the to you incorrectly.

  • Code generated by the IDE/framework, should not be annotated as your own.

  • Code you modified in minor ways e.g. adding a parameter. These should not be claimed as yours but you can mention these additional contributions in the Project Portfolio page if you want to claim credit for them.

 

At the end of the project each student is required to submit a Project Portfolio Page.

• Objective:

  • For you to use  (e.g. in your resume) as a well-documented data point of your SE experience
  • For us to use as a data point to evaluate your,
    • contributions to the project
    • your documentation skills

• Sections to include:

  • Overview: A short overview of your product to provide some context to the reader.

  • Summary of Contributions:

    • Code contributed: Give a link to your code on Project Code Dashboard, which should be https://nus-cs2103-ay1819s1.github.io/cs2103-dashboard/#=undefined&search=githbub_username_in_lower_case (replace githbub_username_in_lower_case with your actual username in lower case e.g., johndoe). This link is also available in the Project List Page -- linked to the icon under your photo.
    • Main feature implemented: A summary of the main feature (the so called major enhancement) you implemented
    • Other contributions:
      • Other minor enhancements you did which are not related to your main feature
      • Contributions to project management e.g., setting up project tools, managing releases, managing issue tracker etc.
      • Evidence of helping others e.g. responses you posted in our forum, bugs you reported in other team's products,
      • Evidence of technical leadership e.g. sharing useful information in the forum

  • Contributions to the User Guide: Reproduce the parts in the User Guide that you wrote. This can include features you implemented as well as features you propose to implement.
    The purpose of allowing you to include proposed features is to provide you more flexibility to show your documentation skills. e.g. you can bring in a proposed feature just to give you an opportunity to use a UML diagram type not used by the actual features.

  • Contributions to the Developer Guide: Reproduce the parts in the Developer Guide that you wrote. Ensure there is enough content to evaluate your technical documentation skills and UML modelling skills. You can include descriptions of your design/implementations, possible alternatives, pros and cons of alternatives, etc.

  • If you plan to use the PPP in your Resume, you can also include your SE work outside of the module (will not be graded)

• Format:

  • File name: docs/team/githbub_username_in_lower_case.adoc e.g., docs/team/johndoe.adoc

  • Follow the example in the AddressBook-Level4, but ignore the following two lines in it.
    

    • Minor enhancement: added a history command that allows the user to navigate to previous commands using up/down keys.
    • Code contributed: [Functional code] [Test code] {give links to collated code files}

  • 💡 You can use the Asciidoc's include feature to include sections from the developer guide or the user guide in your PPP. Follow the example in the sample.

  • It is assumed that all contents in the PPP were written primarily by you. If any section is written by someone else  e.g. someone else wrote described the feature in the User Guide but you implemented the feature, clearly state that the section was written by someone else  (e.g. Start of Extract [from: User Guide] written by Jane Doe).  Reason: Your writing skills will be evaluated based on the PPP

  • Page limit: If you have more content than the limit given below, shorten (or omit some content) so that you do not exceed the page limit. Having too much content in the PPP will be viewed unfavorably during grading. Note: the page limits given below are after converting to PDF format. The actual amount of content you require is actually less than what these numbers suggest because the HTML → PDF conversion adds a lot of spacing around content.

    Content	Limit
    Overview + Summary of contributions	0.5-1
    Contributions to the User Guide	1-3
    Contributions to the Developer Guide	3-6
    Total	5-10

Follow the forking workflow in your project up to v1.1. In particular,

• Get team members to review PRs. A workflow without PR reviews is a risky workflow.
• Do not merge PRs failing CI. After setting up Travis, the CI status of a PR is reported at the bottom of the PR page. The screenshot below shows the status of a PR that is passing all CI checks.
  
  If there is a failure, you can click on the Details link in corresponding line to find out more about the failure. Once you figure out the cause of the failure, push the a fix to the PR.
• After setting up Netlify, you can use Netlify PR Preview to preview changes to documentation files, if the PR contains updates to documentation. To see the preview, click on the Details link in front of the Netlify status reported (refer screenshot above).

After completing v1.1, you can adjust process rigor to suit your team's pace, as explained below.

• Reduce automated tests have benefits, but they can be a pain to write/maintain; GUI tests are especially hard to maintain because their behavior can sometimes depend on things such as the OS, resolution etc.
  It is OK to get rid of some of the troublesome tests and rely more on manual testing instead. The less automated tests you have, the higher the risk of regressions; but it may be an acceptable trade-off under the circumstances if tests are slowing you down too much.
  There is no direct penalty for removing GUI tests. Also note our expectation on test code.

• Reduce automated checks: You can also reduce the rigor of checkstyle checks to expedite PR processing.

• Switch to a lighter workflow: While forking workflow is the safest, it is also rather heavy. You an switch to a simpler workflow if the forking workflow is slowing you down. Refer the textbook to find more about alternative workflows: branching workflow, centralized workflow. However, we still recommend that you use PR reviews, at least for PRs affecting others' features.

You can also increase the rigor/safety of your workflow in the following ways:

• Use GitHub's Protected Branches feature to protect your master branch against rogue PRs.

 

• There is no requirement for a minimum coverage level. Note that in a production environment you are often required to have at least 90% of the code covered by tests. In this project, it can be less. The less coverage you have, the higher the risk of regression bugs, which will cost marks if not fixed before the final submission.
• You must write some tests so that we can evaluate your ability to write tests.
• How much of each type of testing should you do? We expect you to decide. You learned different types of testing and what they try to achieve. Based on that, you should decide how much of each type is required. Similarly, you can decide to what extent you want to automate tests, depending on the benefits and the effort required.
• Applying TDD is optional. If you plan to test something, it is better to apply TDD because TDD ensures that you write functional code in a testable way. If you do it the normal way, you often find that it is hard to test the functional code because the code has low testability.

 

Project Management → Revision Control →

Forking Flow

In the forking workflow, the 'official' version of the software is kept in a remote repo designated as the 'main repo'. All team members fork the main repo create pull requests from their fork to the main repo.

To illustrate how the workflow goes, let’s assume Jean wants to fix a bug in the code. Here are the steps:

1. Jean creates a separate branch in her local repo and fixes the bug in that branch.
2. Jean pushes the branch to her fork.
3. Jean creates a pull request from that branch in her fork to the main repo.
4. Other members review Jean’s pull request.
5. If reviewers suggested any changes, Jean updates the PR accordingly.
6. When reviewers are satisfied with the PR, one of the members (usually the team lead or a designated 'maintainer' of the main repo) merges the PR, which brings Jean’s code to the main repo.
7. Other members, realizing there is new code in the upstream repo, sync their forks with the new upstream repo (i.e. the main repo). This is done by pulling the new code to their own local repo and pushing the updated code to their own fork.

• A detailed explanation of the Forking Workflow - From Atlassian

Documentation:

Recommended procedure for updating docs:

1. Divide among yourselves who will update which parts of the document(s).
2. Update the team repo by following the workflow mentioned above.

Update the following pages in your project repo:

• About Us page: This page is used for module admin purposes. Please follow the format closely or else our scripts will not be able to give credit for your work.
  • Replace info of SE-EDU developers with info of your team, including a suitable photo as described here.
  • Including the name/photo of the supervisor/lecturer is optional.
  • The photo of a team member should be doc/images/githbub_username_in_lower_case.png e.g. docs/images/damithc.png. If you photo is in jpg format, name the file as .png anyway.
  • Indicate the different roles played and responsibilities held by each team member. You can reassign these roles and responsibilities (as explained in Admin Project Scope) later in the project, if necessary.

 

• The purpose of the profile photo is for the teaching team to identify you. Therefore, you should choose a recent individual photo showing your face clearly (i.e., not too small) -- somewhat similar to a passport photo. Some examples can be seen in the 'Teaching team' page. Given below are some examples of good and bad profile photos.
  

• If you are uncomfortable posting your photo due to security reasons, you can post a lower resolution image so that it is hard for someone to misuse that image for fraudulent purposes. If you are concerned about privacy, you can request permission to omit your photo from the page by writing to prof.

 

Roles indicate aspects you are in charge of and responsible for. E.g., if you are in charge of documentation, you are the person who should allocate which parts of the documentation is to be done by who, ensure the document is in right format, ensure consistency etc.

This is a non-exhaustive list; you may define additional roles.

• Team lead: Responsible for overall project coordination.
• Documentation (short for ‘in charge of documentation’): Responsible for the quality of various project documents.
• Testing: Ensures the testing of the project is done properly and on time.
• Code quality: Looks after code quality, ensures adherence to coding standards, etc.
• Deliverables and deadlines: Ensure project deliverables are done on time and in the right format.
• Integration: In charge of versioning of the code, maintaining the code repository, integrating various parts of the software to create a whole.
• Scheduling and tracking: In charge of defining, assigning, and tracking project tasks.
• [Tool ABC] expert: e.g. Intellij expert, Git expert, etc. Helps other team member with matters related to the specific tool.
• In charge of[Component XYZ]: e.g. In charge of Model, UI, Storage, etc. If you are in charge of a component, you are expected to know that component well, and review changes done to that component in v1.3-v1.4.

Please make sure each of the important roles are assigned to one person in the team. It is OK to have a 'backup' for each role, but for each aspect there should be one person who is unequivocally the person responsible for it.

• Contact Us Page: Update to match your product.

• README.adoc page: Update it to match your project.

  • Add a UI mockup of your intended final product.
    Note that the image of the UI should be docs/images/Ui.png so that it can be downloaded by our scripts. Limit the file to contain one screenshot/mockup only and ensure the new image is roughly the same height x width proportions as the original one. Reason: when we compile these images from all teams into one page (example), yours should not look out of place.

  • The original README.adoc file (which doubles as the landing page of your project website) is written to read like the introduction to an SE learning/teaching resource. You should restructure this page to look like the home page of a real product (not a school project) targeting real users  e.g. remove references to addressbook-level3, Learning Outcomes etc. mention target users, add a marketing blurb etc. On a related note, also remove Learning Outcomes link and related pages.

  • Update the link of the Travis build status badge () so that it reflects the build status of your team repo.
    For the other badges,

    • either set up the respective tool for your project (AB-4 Developer Guide has instructions on how to set up AppVeyor and Coveralls) and update the badges accordingly,
    • or remove the badge.

  • Acknowledge the original source of the code i.e. AddressBook-Level4 project created by SE-EDU initiative at https://github.com/se-edu/

• User Guide: Start moving the content from your User Guide (draft created in previous weeks) into the User Guide page in your repository. If a feature is not implemented, mark it as 'Coming in v2.0' (example).

• Developer Guide: Similar to the User Guide, start moving the content from your Developer Guide (draft created in previous weeks) into the Developer Guide page in your team repository.

Product:

• Each member can attempt to do a local-impact change to the code base.

  Objective: To familiarize yourself with at least one components of the product.

  Description: Divide the components among yourselves. Each member can do some small enhancements to their component(s) to learn the code of that component. Some suggested enhancements are given in the AddressBook-Level4 developer guide.

  Submission: Create PRs from your own fork to your team repo. Get it merged by following your team's workflow.

• Adjust process rigor to suit your team's pace, as explained in the panel below.

• Adjust project plan if necessary. Now that you have a some idea about the code base, revisit the feature release plan and adjust it if necessary.

• Set up the issue tracker as described in the panel below, if you haven't done so already.

• Start proper schedule tracking and milestone management as explained in the panel below.