hectorsector / final-project

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Final Project for COP 1000

You'll have two weeks to complete this project. The first week will be spent scoping out your project with the help of your classmates and instructor. Your second week will be spent coding your project. More details are provided below.

About The Final Project Repository

The final project repository housed here will maintain conversations about the project. Additionally, you'll fork and clone the class repository to your personal GitHub account. This is where you'll create your files and you'll submit them for grading via a pull request, as we've done in past projects.

Part 1

Your goals for Part 1 of the final project should be:

  • narrow down the topic of your final project
  • create a proposal for your final project
  • solicit feedback from classmates
  • get final approval 👍 from instructor
  • provide feedback to classmates on their proposal
  • create a rough design of your final project

‼️ Deliverables for Part 1

To achieve your Part 1 goals, complete the following for credit:

  • Fork this project.

    • You'll then be able to ✅ the items on this list, but only on your own fork.
  • Create an Issue with your project proposal.

    • The Issue will automatically populate with some fields for you to fill in. Answer the questions that autopopulate.
    • Feel free to add comments about what you'd like some feedback from classmates or the professor on.
  • Provide feedback to Issues opened by your classmates. You need to provide feedback to at least 3 classmates for credit. Some useful feedback would be:

    • does the project seem like too much work to be done in 1 week? If not, how could you suggest the project be modified so it fits into the given timeframe?
    • what obstacles might your classmate have missed?
    • does the project utilize topics learned throughout the semester?
    • does your classmate describe a general plan for achieving his/her desired project? the plan could be an outline, diagram, drawing, written description of programming structure, pseudocode, etc.
  • Keep an eye on your notifications so that you can continue conversations on your own Issue but also on the Issues in which you have given feedback. When you receive a 👍 from the professor, you can begin implementing.

Part 2

Your goals for Part 2 of the final project should be:

  • finalize your design from Week 1
  • implement your final project (this is the coding portion!)
  • solicit feedback from classmates
  • provide feedback to classmates

‼️ Deliverables for Part 2

To achieve your part 2 goals, complete the following for credit:

  • Clone the final-project repository from your own fork. This will download a copy of the repo to your computer so you can begin adding files. Just like we've done in previous projects.

  • Formalize the design you discussed in Week 1 by adding one or more files to the design folder. These files can be outlines, diagrams, written descriptions of programming structure, pseudocode, or anything that helps you plan out BEFORE you begin coding.

  • Add your python program to the devel folder.

  • Update the README.md file to your devel folder explaining, in detail, how to run your program. Instructions are in the starter file I placed in the devel folder.

  • Once finished, commit any final changes like you've done for previous projects, and sync your changes up to GitHub.

  • Create a pull request to turn in this assignment. In your pull request, include questions you'd like your classmates to give you feedback on.

  • Give feedback to your classmates via the open pull requests page. You need to provide feedback to at least 3 classmates for credit. Some useful feedback would be:

    • Does the classmate's project run on your computer? Don't be afraid to ask for help if it doesn't, this is a learning experience for both you and the other student.
    • What did you like the most about the project?
    • Is there something that you think the other student could change about the project to make it easier to use, or to improve the quality of the project?
    • Do you yourself understand the concepts the student implemented? You can ask questions as part of the open pull request if you do not.
    • If you'd like to get someone's attention, at-mention them by using the @ symbol and their username (like @halfaro1, for example)
    • Be a cheerleader for your classmates and provide ✨
  • Monitor your own open pull request for feedback from other classmates or the instructor. Incorporate the feedback. When the instructor closes your pull request, you can consider yourself finished. But don't be afraid to introduce new changes or continue the conversation!

About