tP: v1.4
Submissions:
v1.4
.[team][product name].jar
e.g. [CS2103T-W09-1][ContactsPlus].jarRelevant: [
@@author
annotations after the deadline will be considered a later submission). Note that the quality of the code attributed to you accounts for a significant component of your final
score, graded individually.Relevant: [
[TEAM_ID][product Name]UserGuide.pdf
e.g.[CS2103T-W09-1][Contacts Plus]UserGuide.pdfRelevant: [
Coming in v2.0
.
[TEAM_ID][product Name]DeveloperGuide.pdf
e.g. [CS2103T-W09-1][Contacts Plus]DeveloperGuide.pdfRelevant: [
[TEAM_ID][Your full Name as Given in LumiNUS]Portfolio.pdf
e.g.[CS2103T-W09-1][Leow Wai Kit, John]Portfolio.pdf-
in place of /
if your name has it e.g., Ravi s/o Veegan
→ Ravi s-o Veegan
(reason: Windows does not allow
/
in file names)github.io
Relevant: [
At the end of the project each student is required to submit a Project Portfolio Page.
Keep in mind that your feature(s) will be evaluated for depth, completeness, and effort. Use the PPP to
convince evaluator how good those aspects of your features are.
It is fine if you want to directly explain each of those aspects of your features in the PPP i.e., how deep the feature is, why it is complete, how hard it was to implement.
[Optional] 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.
[Optional] 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.
[Optional] 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).
File name: docs/team/githbub_username_in_lower_case.adoc
e.g., docs/team/goodcoder123.adoc
Follow the example in the AddressBook-Level3
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.
Content | Recommended | Hard Limit |
---|---|---|
Overview + Summary of contributions | 0.5-1 | 2 |
[Optional] Contributions to the User Guide | 1-3 | |
[Optional] Contributions to the Developer Guide | 3-6 |
README
page, Ui.png
, AboutUs
) on GitHub. Ensure the website is auto-published.Relevant: [
Ui.png
matches the current productSome common sense tips for a good product screenshot
Ui.png
represents your product in its full glory.
Reason: Distracting annotations.
Reason: Not enough data.
Reason: screenshot not cropped cleanly (contains extra background details)
The purpose of the profile photo is for the teaching team to identify you. Therefore, 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 may use a placeholder image in place of the photo in module-related documents that are publicly visible.
Relevant: [
Here is an example:
Hi, welcome to the demo of our product FooBar. It is a product to ensure the user takes
frequent standing-breaks while working.
It is for someone who works at a PC, prefers typing, and wants to avoid prolonged periods
of sitting.
The user first sets the parameters such as frequency and targets, and then enters a
command to record the start of the sitting time, ... The app shows the length of the
sitting periods, and alerts the user if ...
...
Jim get’s a call from boss. "Ring ring", "hello", "oh hi Jim, can we postpone the meeting?" "Sure". Jim hang up and curses the boss under his breath. Now he starts typing ..etc.
If Jim needs to postpone the meeting, he can type …
1
and 3
will start at 05-minutes mark (e.g., 11.05 am), and teams 2
and 4
start at 30-minutes mark (e.g., 11.30 am).Objectives:
Grading:
Relevant: [
severity.High
> severity.Medium
> severity.Low
> severity.VeryLow
type.FunctionalityBug
> type.DocumentationBug
> type.FeatureFlaw
n
bugs found in your feature; it is a difficult feature consisting of lot of code → 4/5 marksn
bugs found in your feature; it is a small feature with a small amount of code → 1/5 marks
Ensure that you have accepted the invitation to join the GitHub org used by the module. Go to https://github.com/nus-cs2103-AY1920S2 to accept the invitation.
Ensure you have access to a computer that is able to run module projects e.g. has the right Java version.
Issues created for PED and PE need to be in a precise format for our grading scripts to work. Incorrectly-formatted responses will have to discarded. Therefore, you are strongly recommended to use CATcher for PED and PE activities. If you want to give your response via GitHub instead, please get our permission first.
ped
pe
Bug Severity labels:
severity.VeryLow
: A flaw that is purely cosmetic and does not affect usage e.g., a typo/spacing/layout/color/font issues in the docs or the UI that doesn't affect usage.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.Type labels:
type.FunctionalityBug
: A functionality does not work as specified/expected.type.FeatureFlaw
: Some functionality missing from a feature delivered in v1.4 in a way that the feature becomes less useful to the intended target user for normal usage. i.e., the feature is not 'complete'.
In other words, an acceptance testing bug that falls within the scope of v1.4 features. These issues are counted against the 'depth and completeness' of the feature.type.DocumentationBug
: A flaw in the documentation that can potentially affect the user e.g., a missing step, a wrong instruction, typos that affect usersHave a good screen grab tool with annotation features so that you can quickly take a screenshot of a bug, annotate it, and post in the issue tracker.
Download the product to be tested
Charge your computer before coming to the session. The testing venue might not have enough charging points.
Relevant: [
Objectives:
Grading:
Relevant: [
severity.High
> severity.Medium
> severity.Low
> severity.VeryLow
type.FunctionalityBug
> type.DocumentationBug
> type.FeatureFlaw
n
bugs found in your feature; it is a difficult feature consisting of lot of code → 4/5 marksn
bugs found in your feature; it is a small feature with a small amount of code → 1/5 marks
Ensure that you have accepted the invitation to join the GitHub org used by the module. Go to https://github.com/nus-cs2103-AY1920S2 to accept the invitation.
Ensure you have access to a computer that is able to run module projects e.g. has the right Java version.
Issues created for PED and PE need to be in a precise format for our grading scripts to work. Incorrectly-formatted responses will have to discarded. Therefore, you are strongly recommended to use CATcher for PED and PE activities. If you want to give your response via GitHub instead, please get our permission first.
ped
pe
Bug Severity labels:
severity.VeryLow
: A flaw that is purely cosmetic and does not affect usage e.g., a typo/spacing/layout/color/font issues in the docs or the UI that doesn't affect usage.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.Type labels:
type.FunctionalityBug
: A functionality does not work as specified/expected.type.FeatureFlaw
: Some functionality missing from a feature delivered in v1.4 in a way that the feature becomes less useful to the intended target user for normal usage. i.e., the feature is not 'complete'.
In other words, an acceptance testing bug that falls within the scope of v1.4 features. These issues are counted against the 'depth and completeness' of the feature.type.DocumentationBug
: A flaw in the documentation that can potentially affect the user e.g., a missing step, a wrong instruction, typos that affect usersHave a good screen grab tool with annotation features so that you can quickly take a screenshot of a bug, annotate it, and post in the issue tracker.
Download the product to be tested
Charge your computer before coming to the session. The testing venue might not have enough charging points.
java -version
command to ensure you are using Java 11.java -jar
command (do not use double-clicking).help
command).Relevant: [
These are considered functionality bugs:
Behavior differs from the User Guide
A legitimate user behavior is not handled e.g. incorrect commands, extra parameters
Behavior is not specified and differs from normal expectations e.g. error message does not match the error
Relevant: [
These will be considered feature flaws:
The feature does not solve the stated problem of the intended user i.e., the feature is 'incomplete'
Hard-to-test features
Features that don't fit well with the product
Features that are not optimized enough for fast-typists or target users
Relevant: [
These are considered UG bugs (if they hinder the reader):
Not enough visuals e.g., screenshots/diagrams
The visuals are not well integrated to the explanation.
The visuals are unnecessarily repetitive e.g., same visual repeated with minor changes.
Not enough examples e.g., sample inputs/outputs.
The explanation is too brief or unnecessarily long.
The information is hard to understand for the target audience. e.g., using terms the reader might not know
The document looks messy, or not well-formatted.
Relevant: [
These are considered DG bugs (if they hinder the reader):
These are considered UG bugs (if they hinder the reader):
Not enough visuals e.g., screenshots/diagrams
The visuals are not well integrated to the explanation.
The visuals are unnecessarily repetitive e.g., same visual repeated with minor changes.
Not enough examples e.g., sample inputs/outputs.
The explanation is too brief or unnecessarily long.
The information is hard to understand for the target audience. e.g., using terms the reader might not know
The document looks messy, or not well-formatted.
UML notation incorrect or not compliant with the notation covered in the module.
Some other type of diagram used when a UML diagram would have worked just as well.
The diagram used is not suitable for the purpose it is used.
The diagram is too complicated.
Excessive use of code e.g., a large chunk of code is cited when a smaller extract of would have sufficed.
Type.FeatureFlaw
.CS2103/T PE Dry run
CS2103/T PE
ped
pe
severity.*
label to the bug report. Bug report without a severity label are considered severity.Low
(lower severity bugs earn lower credit)Bug Severity labels:
severity.VeryLow
: A flaw that is purely cosmetic and does not affect usage e.g., a typo/spacing/layout/color/font issues in the docs or the UI that doesn't affect usage.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.type.*
label to the issue.Type labels:
type.FunctionalityBug
: A functionality does not work as specified/expected.type.FeatureFlaw
: Some functionality missing from a feature delivered in v1.4 in a way that the feature becomes less useful to the intended target user for normal usage. i.e., the feature is not 'complete'.
In other words, an acceptance testing bug that falls within the scope of v1.4 features. These issues are counted against the 'depth and completeness' of the feature.type.DocumentationBug
: A flaw in the documentation that can potentially affect the user e.g., a missing step, a wrong instruction, typos that affect usersRelevant: [
These are considered UG bugs (if they hinder the reader):
Not enough visuals e.g., screenshots/diagrams
The visuals are not well integrated to the explanation.
The visuals are unnecessarily repetitive e.g., same visual repeated with minor changes.
Not enough examples e.g., sample inputs/outputs.
The explanation is too brief or unnecessarily long.
The information is hard to understand for the target audience. e.g., using terms the reader might not know
The document looks messy, or not well-formatted.
Relevant: [
These are considered DG bugs (if they hinder the reader):
These are considered UG bugs (if they hinder the reader):
Not enough visuals e.g., screenshots/diagrams
The visuals are not well integrated to the explanation.
The visuals are unnecessarily repetitive e.g., same visual repeated with minor changes.
Not enough examples e.g., sample inputs/outputs.
The explanation is too brief or unnecessarily long.
The information is hard to understand for the target audience. e.g., using terms the reader might not know
The document looks messy, or not well-formatted.
UML notation incorrect or not compliant with the notation covered in the module.
Some other type of diagram used when a UML diagram would have worked just as well.
The diagram used is not suitable for the purpose it is used.
The diagram is too complicated.
Excessive use of code e.g., a large chunk of code is cited when a smaller extract of would have sufficed.
A. Product Design []:
Evaluate the product design based on the User Guide and the actual product behavior.
Target user:
target user specified and appropriate
: The target user is clearly specified, prefers typing over other modes of input, and not too general (should be
narrowed to a specific user group with certain characteristics).value specified and matching
: The value offered by the product is clearly specified and matches the target user.optimized for the target user
: It feels like a fast typist can be more productive with the app, compared to an equivalent GUI app without a CLI.Value to the target user:
B. Quality of user docs []:
UG: Compared to AB3, the quality of this UG is,
C. Quality of developer docs []:
DG: similar to UG
D. Feature Quality []:
Quality: Compared to AB3, the quality of this product is,
E. Amount of work []:
Effort: Assume the effort required to create AB3 from scratch is 10 in a scale of 0 to 30. How much effort do you estimate the team put in for this project?
This phase is for you to respond to the bug reports you received.
Duration: The review period will start around 1 day after the PE (exact time to be announced) and will last until the following Tuesday midnight. However, you are recommended to finish this task ASAP, to minimize cutting into your exam preparation work.
Bug reviewing is recommended to be done as a team as some of the decisions need team consensus.
Instructions for Reviewing Bug Reports
Sync
button at the top to force-sync your view with the latest data from GitHub.
CS2103/T PE
. It will show all the bugs assigned to your team, divided into three sections:
Issues Pending Responses
- Issues that your team has not processed yet.Issues Responded
- Your job is to get all issues to the second category.Faulty Issues
- e.g., Bugs marked as duplicates of each other, or causing circular duplicate relationships. Fix the problem given so that no issues remain in this category.Issues created for PE-D and PE need to be in a precise format for our grading scripts to work. Incorrectly-formatted responses will have to discarded. Therefore, you are strongly recommended to use CATcher for PE-D and PE activities. If you want to give your response via GitHub instead, please get our permission first.
tutorial.*
and team.*
labels to filter bug reports your team received.# Team's Response
{replace this with your response}
## Duplicate status (if any):
Here is an example:
# Team's Response
Yes this is a bug. But it is a duplicate.
* Changed the bug type because this is just a bug in the UG.
* Lowered the severity because users can still use the feature.
## Duplicate status (if any):
Duplicate of #67
Duplicate of #123
format to indicate duplicates.duplicate
tag.type.*
and severity.*
from the original.response.Accepted
)Response Labels:
response.Accepted
: You accept it as a bug.response.NotInScope
: It is a valid issue but not something the team should be penalized for e.g., it was not related to features delivered in v1.4.response.Rejected
: What tester treated as a bug is in fact the expected behavior. You can reject bugs that you inherited from AB3.response.CannotReproduce
: You are unable to reproduce the behavior reported in the bug after multiple tries.response.IssueUnclear
: The issue description is not clear. Don't post comments asking the tester to give more info. The tester will not be able to see those comments because the bug reports are anonymous.type.FunctionalityBug
)Type labels:
type.FunctionalityBug
: A functionality does not work as specified/expected.type.FeatureFlaw
: Some functionality missing from a feature delivered in v1.4 in a way that the feature becomes less useful to the intended target user for normal usage. i.e., the feature is not 'complete'. In other
words, an acceptance testing bug that falls within the scope of v1.4 features. These issues are counted against the 'depth and completeness' of the feature.type.DocumentationBug
: A flaw in the documentation that can potentially affect the user e.g., a missing step, a wrong instruction, typos that affect usersBug Severity labels:
severity.VeryLow
: A flaw that is purely cosmetic and does not affect usage e.g., a typo/spacing/layout/color/font issues in the docs or the UI that doesn't affect usage.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.Assignees
field to assign the issue to that person(s). There is no need to actually fix the bug though. It's simply an indication/acceptance of responsibility. If there is no assignee, we will distribute the penalty for that bug (if any) among all team members.
As far as possible, choose the correct type.*
, severity.*
, and assignees even for bugs you are not accepting or for bugs that are marked as duplicates. Reason: your non-acceptance or duplication
status may be rejected in a later phase, in which case we need to grade it as an accepted/non-duplicate bug.
Justify your response. For all of the following cases, you must add a comment justifying your stance. Testers will get to respond to all those cases and will be double-checked by the teaching team in later phases. Indiscriminate/unreasonable dev/tester responses, if deemed as a case of trying to game the system, will be penalized.
CS2103/T PE
).I disagree
tick box and enter your justification for the disagreement, and click Save
.Issues created for PE-D and PE need to be in a precise format for our grading scripts to work. Incorrectly-formatted responses will have to discarded. Therefore, you are strongly recommended to use CATcher for PE-D and PE activities. If you want to give your response via GitHub instead, please get our permission first.
pe
repo.[ ] I disagree
tick box. Edit the comment (do not add a new comment) to replace the [replace this with your reason]
with your reasoning. Here is an example:Team chose ['response.IssueUnclear']
- [x] I disagree
**Reason for disagreement:** I think one can easily reproduce the problem by following the steps I gave.