Skip to content

Commit

Permalink
added table for status of features in report
Browse files Browse the repository at this point in the history
  • Loading branch information
abhutta0 committed Mar 13, 2024
1 parent 161def2 commit 9277ea6
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 5 deletions.
6 changes: 3 additions & 3 deletions Assignments/project-deliverable.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Your final team deliverable will be a "release" of your new feature on GitHub (w
Your final team deliverable will include:
* The implementation of your new feature, deployed to Netlify + Heroku / Render.com
* Automated tests for your new feature
* A report that describes how to use your new feature
* A report that describes how to use your new feature and what was completed vs proposed
* A poster and/or demo

Accompanying the final team deliverable will be an *individual reflection*, which every student must submit on their own which will include your reflections on the evolution of your project concept, on the software engineering processes you used, and on your team's dynamics and collaboration.
Expand All @@ -25,7 +25,7 @@ Accompanying the final team deliverable will be an *individual reflection*, whic
### Submission Instructions

#### Code, documentation and Link
All apps will be deployed on Netlify and Heroku / Render (instructions for CI/CD pipeline setup are provided separately). After you have pushed all of your code (and documentation) to your team's GitHub repository, create [a release](https://docs.github.com/en/free-pro-team@latest/github/administering-a-repository/managing-releases-in-a-repository) on GitHub, and apply the tag version `final-submission`. After your release is created, you'll find that there is now a `.zip` that can be downloaded from GitHub that contains a snapshot of your entire repository. Download this zip file, unpack it, and follow the instructions that you provided in your README to double-check that the course staff will be able to run your project (this step is handy to make sure that you didn't forget to include some key files in git). If needed, you can delete the release, make some changes, and re-release up until the deadline. **Submit this zip file to Canvas** under the assignment "Project: Code Submission" along with the link of your hosted app (in comments or a text file). Submit your report separately to Canvas, under the assignment "Project: Report".
All apps will be deployed on Heroku / Render (instructions for CI/CD pipeline setup are provided separately). After you have pushed all of your code (and documentation) to your team's GitHub repository, create [a release](https://docs.github.com/en/free-pro-team@latest/github/administering-a-repository/managing-releases-in-a-repository) on GitHub, and apply the tag version `final-submission`. After your release is created, you'll find that there is now a `.zip` that can be downloaded from GitHub that contains a snapshot of your entire repository. Download this zip file, unpack it, and follow the instructions that you provided in your README to double-check that the course staff will be able to run your project (this step is handy to make sure that you didn't forget to include some key files in git). If needed, you can delete the release, make some changes, and re-release up until the deadline. **Submit this zip file to Canvas** under the assignment "Project: Code Submission" along with the link of your hosted app (in comments or a text file). Submit your report separately to Canvas, under the assignment "Project: Report".

#### Project Poster & Demo
Each team will submit a poster. Your poster will be a single-page document, that will include the following aspects:
Expand All @@ -41,7 +41,7 @@ We've created a [sample poster for the "Conversation Areas" feature]({{ site.bas
In addition, some sections will have live (in-person) demos and others may ask you to record a demo video. Details for project demos and/or presentations will be provided during class by each instructor (and may vary from section to section). **Posters and/or demo videos and/or presentations will be submitted on Canvas**, under the assignment "Project: Poster / Demo".

#### Project Showcase
We will create a project showcase page for this semester (similar to the ones from [Fall 2023](https://neu-se.github.io/CS4530-Fall-2023/assignments/project-showcase) semester). Please fill out this form **TODO** to indicate your preference (whether you want your project to be posted there or not). We often direct recruiters to that page.
We will create a project showcase page for this semester (similar to the one from [Fall 2023](https://neu-se.github.io/CS4530-Fall-2023/assignments/project-showcase) semester). Please indicate your preference (whether you want your project to be posted there or not) by completing a survey (a link can be found in Canvas assignment "Project: Permission for Showcase Page"). We often direct recruiters to that page.

#### Individual Reflection
Create a PDF of your reflection, and submit it to Canvas, under the assignment "Project: Individual Reflection".
Expand Down
6 changes: 4 additions & 2 deletions Assignments/project-grading.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,11 +117,13 @@ The allocation of the 10% credit will be as follows: Overview and manual will be
* Technical Overview contains a description of any substantive changes to the existing Covey.Town codebase, and of the architecture of your new code.
* When appropriate, it uses diagrams and/or figures to illustrate a design (there is no requirement to use a specific tool or format for this - students often use lucidchart, draw.io, [mermaid](https://mermaid.live) or even hand-drawn diagrams).
* It provides a well-reasoned rationale for why this is the "right" design.
* The document is at most 2 pages (fewer pages are absolutely acceptable, consider this a rough limit)
* It provides a table showing the status of all proposed user stories and conditions of satisfaction (proposed vs completed). The status could be fully implemented, partially implementted (feel free to add percentages), not completed.
* The document is at most 2 pages (fewer pages are absolutely acceptable, consider this a rough limit) excluding the table.

#### Meets minimum requirements:
* Technical Overview includes a description of all major changes to the code compared to our existing Covey.Town codebase.
* The document is at most 2 pages (fewer pages are absolutely acceptable, consider this a rough limit)
* It provides a table showing the status of all proposed user stories and conditions of satisfaction (proposed vs completed). The status could be fully implemented, partially implementted (feel free to add percentages), not completed.
* The document is at most 2 pages (fewer pages are absolutely acceptable, consider this a rough limit) excluding the table.

### * Process Overview
#### Satisfactory:
Expand Down

0 comments on commit 9277ea6

Please sign in to comment.