CS2113/T AY1819S1
  • Nested (current format)
  •     Flat
  • Schedule
  • Textbook
  • Admin Info
  • Report Bugs
  • Slack
  • Forum
  • Instructors
  • IVLE Announcements
  • IVLE File Submissions
  • Tutorial Schedule
  • Java Coding Standard
  • samplerepo-things
  • Addressbook-level1
  • Addressbook-level2
  • Addressbook-level3
  • Addressbook-level4
  • Projects List
  • Code Dashboard (BETA)
  • Project: mid-v1.1 [week 6] Project: mid-v1.2 [week 8]


    Project: v1.1 [week 7]

    Overview: Update UG and DG in the repo, update project plan in repo, attempt to do global-impact changes to the code base.

    v1.1 Summary of Milestone

    Milestone Minimum acceptable performance to consider as 'reached'
    Team org/repo set up as stated
    Project plan formalized as stated
    Have done some enhancement to the code at least attempted to enhance the code of a component, even if you did not fully succeed
    All project documents updated as required updated docs are merged to the master branch

    Reminder: Reaching individual and team milestones are considered for grading the project management component of your project grade.

    A. Process:

    Evaluates: How well you did in project management related aspects of the project, as an individual and as a team

    Based on: Supervisor observations of project milestones and GitHub data.

    Milestones need to be reached the midnight before of the tutorial for it to be counted as achieved. To get a good grade this aspect, achieve recommended weekly progress in at least 6/10 weeks.

    Other criteria:

    • Good use of GitHub milestones
    • Good use of GitHub release mechanism
    • Good version control, based on the repo
    • Reasonable attempt to use the forking workflow
    • Good task definition, assignment and tracking, based on the issue tracker
    • Good use of buffers (opposite: everything at the last minute)
    • Project done iteratively and incrementally (opposite: doing most of the work in one big burst)

    B. Team-based tasks:

    Evaluates: How much you contributed to common team-based tasks

    Based on: peer evaluations and tutor observations

    Relevant: [Admin Project Scope → Examples of team tasks ]

    Here is a non-exhaustive list of team-tasks:

    1. Necessary general code enhancements e.g.,
      1. Work related to renaming the product
      2. Work related to changing the product icon
      3. Morphing the product into a different product
    2. Setting up the GitHub, Travis, AppVeyor, etc.,
    3. Maintaining the issue tracker
    4. Release management
    5. Updating user/developer docs that are not specific to a feature  e.g. documenting the target user profile
    6. Incorporating more useful tools/libraries/frameworks into the product or the project workflow (e.g. automate more aspects of the project workflow using a GitHub plugin)

    v1.1 Project Management

    • Fix any errors in org/repo set up  (e.g. wrong repo name).

    • When all changes intended for v1.1 is merged to the master branch, use git tag feature to tag the current version as v1.1

    • Start tracking your project schedule using GitHub issue tracker and milestones. More instructions coming soon.

    v1.1 Documentation

    • Update User Guide, Developer Guide, README, and About Us pages as described earlier.

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

    v1.1 Product

    • Each member should try to add some enhancements that are in line with the vision for v2.0. Preferably, these should be global-impact enhancements, touching as many other components as possible. Refer to the AddressBook-Level4 Developer Guide has some guidance on how to implement a new feature end-to-end.

    Project: mid-v1.1 [week 6] Project: mid-v1.2 [week 8]