Project Template mvp branch

CONTRIBUTING.md

@@ -0,0 +1,37 @@
+# Contributing to Learn.co Curriculum
+
+We're really exited that you're about to contribute to the [open curriculum](https://learn.co/content-license) on [Learn.co](https://learn.co). If this is your first time contributing, please continue reading to learn how to make the most meaningful and useful impact possible.
+
+## Raising an Issue to Encourage a Contribution
+
+If you notice a problem with the curriculum that you believe needs improvement
+but you're unable to make the change yourself, you should raise a Github issue
+containing a clear description of the problem. Include relevant snippets of
+the content and/or screenshots if applicable. Curriculum owners regularly review
+issue lists and your issue will be prioritized and addressed as appropriate.
+
+## Submitting a Pull Request to Suggest an Improvement
+
+If you see an opportunity for improvement and can make the change yourself go
+ahead and use a typical git workflow to make it happen:
+
+* Fork this curriculum repository
+* Make the change on your fork, with descriptive commits in the standard format
+* Open a Pull Request against this repo
+
+A curriculum owner will review your change and approve or comment on it in due
+course.
+
+# Why Contribute?
+
+Curriculum on Learn is publicly and freely available under Learn's
+[Educational Content License](https://learn.co/content-license). By
+embracing an open-source contribution model, our goal is for the curriculum
+on Learn to become, in time, the best educational content the world has
+ever seen.
+
+We need help from the community of Learners to maintain and improve the
+educational content. Everything from fixing typos, to correcting
+out-dated information, to improving exposition, to adding better examples,
+to fixing tests—all contributions to making the curriculum more effective are
+welcome.

LICENSE.md

@@ -0,0 +1,7 @@
+#Learn.co Educational Content License
+
+Copyright (c) 2015 Flatiron School, Inc
+
+The Flatiron School, Inc. owns this Educational Content. However, the Flatiron School supports the development and availability of educational materials in the public domain. Therefore, the Flatiron School grants Users of the Flatiron Educational Content set forth in this repository certain rights to reuse, build upon and share such Educational Content subject to the terms of the Educational Content License set forth [here](http://learn.co/content-license) (http://learn.co/content-license). You must read carefully the terms and conditions contained in the Educational Content License as such terms govern access to and use of the Educational Content.
+
+Flatiron School is willing to allow you access to and use of the Educational Content only on the condition that you accept all of the terms and conditions contained in the Educational Content License set forth [here](http://learn.co/content-license) (http://learn.co/content-license).  By accessing and/or using the Educational Content, you are agreeing to all of the terms and conditions contained in the Educational Content License.  If you do not agree to any or all of the terms of the Educational Content License, you are prohibited from accessing, reviewing or using in any way the Educational Content.

README.md

@@ -1,62 +1,13 @@
-# Module 1 project template - Above and Beyond
+# Phase 1 Project Templates and Examples
 
-![bluebrint2](images/blueprint.png)
+This repo contains templates and examples to help you get started with your Phase 1 Project. Each of these is in a separate branch as explained below.
 
-A blueprint provides guidance and structure before something in created. This repoistory provides similar sturcture and guidance for your first data science project. How analysis is structured is will provide the foundation for your work. This guidance also alllows to students to focus on the _foundational skills_ what will be built upon lter in the course.
+- The **template-mvp** branch is the template you should use to for your Phase 1 Project. MVP stands for Minimum Viable Product, but this isn't meant in a negative way - if your project uses this template, it will be functional and accessible.
 
-Student repositories are  useful in the job search, as employers can see the qualitiy of student work _before_ the interview. To set students up for success, the module 1 project is expected to mirror the structure of this repository. All content is in draft form, to guide students in creating project repositories. Repository structure will mature further with later projects.
+- The **example-mvp** branch is an example project using the MVP template.
 
-This repo contains:
-- TEMPLATE_README: An example of a Readme for your project 
-  - This should be an abstract of your complete analysis
-- `dsc-mod1-project-template.ipynb`: A starter jupyter notebook
-  - inside the notebook there is some text and `| guiding questions within lined sections |` that should be answered in narrative form
-  - sample visualizations. Their code is in the `visualizations.py` file as a reference. 
-- `__init__.py` :python helper file, tells python there are packages 
-- presentation pdf:
-  - PDF of slide deck used in class presentation, [online version also provided](https://docs.google.com/presentation/d/1PnqhxdN1P1tY3MKCXKmShO0sYLRQF2DSMzMN_tnk5xo/edit?usp=sharing) in readme.
-  - The online editable version of this file can be found [here](https://docs.google.com/presentation/d/1iS5kCJVBiieuUEokWLOSjuAxlz9oX-tPV2xr0i9RYdA/edit?usp=sharing)
-  - Please make a copy of the file before editing
-- code folder:
-  - `__init__.py` :python helper file, tells python there are packages 
-  - contains sample `data_cleaning.py` script to clean data and prepare it for analysis and visualization
-  - contains sample `visualizations.py` to produce visualizations
-  - You may find it helpful to have a notebook here for messy EDA or data preparation
-- images folder:
-  - contains images used in jupyter notebook markdown
-- hidden `.gitignore` file that tells git to not track certain files and folders
+Once you've completed your project using the MVP template, you can improve it using the Above and Beyond (AAB) template if you have time:
 
-***
-## Student instructions
+- The **template-aab** branch is the AAB template to use to keep improving your project.
 
-1. Through github, fork this repository to you own account 
-
-**If in a group project, have only one team member do steps one through five**
-
-2. In github, on the forked repo, click "Settings"
-3. On the Setting page, the first tab is "Options". On that page there  "Repository Name" with a text field, and a button "Rename"
-4. Change the name of the forked repo to a _decriptive_ project repo name of your choosing. "Microsoft-Movie-Analsis" is a **better** repo name than "Mod-Project-1"
-5. If you are part of a group project(if not, proceed to step 6):
-   - Go to the "Manage Access" tab within "settings"
-   - Add your project team members as collaborators
-   - copy the link to clone the repository and share it with teammates 
-
-
-6. Through the terminal on your local machine, `git clone` the project to your local computer
-7. Move the data from the project description into the `data` folder on your local machine
-8. You are now ready to start using these materials!
-
-**To use the slide template**
-1. Go to [this link](https://docs.google.com/presentation/d/1eYnFN5ojOD7RNXDv9dj-ZBwrASru0pnlnwTg3NVXdoU/edit?usp=sharing)
-2. The google slides will show that they are "view only"
-3. Go to "File" and select "Make a Copy"
-4. Google will then create an **editable** copy of the slide deck in your own account.
-
-***
-## Please note
-- The code within `visualizations.py` and `data_cleaning.py` is an example of well documented code.
-- The visualizations in the notebook, generated from `visualizations.py` have clear axes, titles, and appropriate number formatting. Please use as a reference.
-- The `dsc-mod1-project-template.ipynb`is intented to be the _final version_ of your project. 
-     - The first noteook you create will not look like this. 
-     - You are encouraged to start with a very disorderly notebook and clean it as you go.
-- Before you finish this project, delete **this** readme from the repo using `git rm README.md`, followed by `git mv TEMPLATE_README.md README.md`
+- The **example-aab** branch is an example project using the AAB template.