Project Files - Organizing your Team and Project!

This project teams will organize both their Microsoft TEAMS Directory and github repository to prepare them for the semester. The key components of this assignment are to draft and organize the following:

1. TEAM Charter Draft this “living” document that outlines your teams logistics. Please use this link to help build your charter and put the official copy in the top level of your TEAMS private folder.
2. TEAMS Public Folder This is a sub-folder in the General channel and is used to share non sensitive files with your classmates. This folder is ONLY for temporary files and should not be the primary home for anything important. Move files from here to the Private folder if it is important.
3. TEAMS Private FOLDER Use this folder to store your primary team organizational documents. This includes the team charter, project data, meeting minutes, NDA/IP agreements, Weekly 3x3 Reports, report drafts, milestones, etc. Details about how to set up this folder can be found in this link
4. Git Repository Use this folder to track your teams software. We expect all teams to use good software management practices when dealing with code and a good version control system is key. Details about how to set up your git repository can be found I this link

Organizing your files in a logical and clean manner is expected. Instructors should never have to question what they are referencing or have trouble finding documents.

Submission

Draft all documents and put them in the required locations.

If you have an IP and NDA agreement have one (and only one) person from your team email the correctly signed documents to your instructors and your community partners. These MUST be professional emails. You can ask an instructor to check it before hitting send.

Basic git INSTRUCTIONS

For this milestone we only need to set up the basic structure with the following. To start, please keep the files simple and do not include files that do not add something to the project (see “what not to include” below):

ProjectName/
    .gitignore
    LICENSE.txt
    README.md

Here is a description of each of these:

• ProjectName - The top level folder is the short name of your team. Give your project a short and memorable name. An ideal name should be descriptive and have meaning to people who may be interested in using your software. A poor name only has meaning to your team. For example, DO NOT USE CMSE495 in the the name. Instead try to pick a name that relates to your project or what you think your project will do. Although we can change the name later it is much easier if we pick a good name to start.
  • README.md - This is a description of your git repository written in Markdown.
  • .gitignore - There are a lot of files that are inappropriate to include in a git repository (more information below) the “Git Ignore” file helps by telling Git that you never want to use these files. There are plenty of examples for good .gitignore files for Python projects on the Internet. Try to include one that makes sense (you can update it as the semester goes on).
  • LICENSE - Use this file to describe your license (See Git Repository Organization in the team guild for more details).

HINT: Many of you may find this git template helpful.

If you need help figuring out how to set up your git repository there are a ton of tutorials online. For example here is a good one:

• git game
• GitBrancing tutorial
• Dirk’s Full Getting to Know Git Tutorial

If you continue to need help go see your instructors.

The following video are instructions specifically for how to use the MSU Gitlab. We will be using the MSU gitlab for all projects because it allows us to best maintain file permissions. If you have a completely opensource project with no NDA or IP agreement you are also allowed to post on Github or other public spaces:

Some of you may get some sort of “Authentication” error when trying to use git on a windows machine (especially if you have your computer already set up to use github). If that is the case, the following video may help you set up an SSH key on your windows machine.

• Direct Link to Windows SSH key generation video

Evaluation and Rubric

Project will be evaluated primary on a teams ability to read and following directions.

Make sure your instructors and classmates have the correct permissions to access, clone your repositories and provide the full git command/instructions in your team charter.

Your instructor will evaluate your assignment by reviewing the following:

• Review of team charter
• Checking pdfs of NDA and IP agreements (if required)
• Forking and cloning your repository using the link in your team charter
• Verify repository/files are hosted properly per NDA/IP agreements
• Reviewing of your git log
• Review of your repository README.md file
• Review of your repository LICENSE.md file
• Checking for reasonable .gitignore file

You will be graded on how well directions were followed and the professionalism of the submission.

Points will be taken off if your signed NDA/IP agreemnts are unprofessional.

The following is an approximate rubric that will be used as a guild for evaluating this assignment.

Post-Evaluation

Review feedback from instructors and ensure that any requested changes are made.