Giter VIP home page Giter VIP logo

philosophy's Introduction

Philosophy

This is a break down of how I believe code should be written. This will focus on three key parts of coding:

  • Writing
  • Testing
  • Organizing

Why these three

It is my belief that these three parts of a project are tightly coupled. One of these can not be at it's best unless the other two are as well.

For example code that is written poorly is very likely to be difficult to test, a project that is poorly organized is very difficult to write in, a project with poor tests will have inconsistent code, etc.

Going forward

This repo will be organized starting with these three key values and then will have sub directories used to explain the best practices for each key. It has been my experience that not all developers read walls of text, due to that most README will be accompanied by code examples. These code examples will be well documented with a lot of repeat information from the section's README.

Order

Each section will be self containing so order doesn't matter, but for the best experience I suggest reading in the following order:

  1. Writing
  2. Testing
  3. Organizing

philosophy's People

Contributors

dillonjason 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.