Git Product home page Git Product logo

dsc-postgrad-repo-org-problems-flatiron-labs's Introduction

Repository Organization Problems

Introduction

During the program, you'll have noticed that the structure of a repository evolves over the course of a project. By the end of the project, you need to pause and review your repository to align it with employer expectations. In this lesson, we'll outline some typical issues that can be easily fixed in order to make your repository exemplary.

Objectives

You will be able to:

  • Identify key issues within an example data science project repository
  • Review industry standards and employer expectations for project organization

Reviewing a Typical Repo and Identifying issues

Typical Repo

Here is a picture of a typical data science project repository. Take a moment to review it and see if you can identify five aspects that could be improved:

messy repo example

Issues Identified

The issues are identified in the picture below.

messy repo example with numbers for problems list

Issues List:

  1. No project description
  2. No .gitignore file , so unwanted files such as .DS_Store and .ipynb_checkpoints are included
  3. Non-descriptive names for the presentation, notebook and data file
  4. Images are at the same level as the rest of the repository, instead of inside an image folder
  5. Data is included in repo instead of in a data folder (or not provided in repo at all)

Cookie Cutter Data Science is a great resource to guide how you structure a repository. At the end of the reorganization, the cleaner project repository will look like this:

polished repo example

A combination of Git & bash commands, along with some thoughtful renaming through GitHub's platform, will fix a messy repository. Please fork and clone the messy repository example if you want to follow along with the steps detailed on your own machine.

Summary

Great! Next up, we'll be guiding you through a list of steps you can use to clean up a repository.

dsc-postgrad-repo-org-problems-flatiron-labs's People

Contributors

aapeebles avatar lindseyberlin avatar loredirick avatar cheffrey2000 avatar maxwellbenton avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.