Giter Club home page Giter Club logo

promdate-docs's Introduction

2381 Robotics README

Why You Should Care

As a wise person once said:

Reading documentation is fucking tedious. Writing documentation is more fucking tedious.

--A Wise Person

And we get it. There are probably many things you want to be doing rather than reading this. That makes sense. In fact, I myself have barely read through the document - and I wrote this shit. However, at 2381 Robotics, we have lots and lots of documentation because it aligns with three of our guiding principles.

PRINCIPLES, PRINCIPALS, AND PINEAPPLES

  • Principle Number One - Engagement

    Robotics is fucking expensive. With respect to both your time and money, this shit ain't cheap - you might want to get your money's worth in return. Documentation helps in two ways -

    1. Maximize your time when you have the robot -> If you are up to date with what is going on within the team and what other people are working on, you will spend less time trying to figure out the fuck is going on and more time getting stuff done.

    2. Contribute even without the robot on hand -> Alot of the time, it won't be possible or convienient for you to be in the same location as the actual robot. Using this time to clean up the style of the code base or adding to the design docuement is a great way to further your own understanding.

  • Principal Number Two - Win

    At 2381 Robotics, our primary goal is to make sure everyone is safe and is having fun to win. Winning is fun, but to do that, our code - as well as our overall design - needs to not be shit.

Code Quality BTW

  • Pineapple Number Three - Help Others

    Whenever you are writing anything, keep in mind that some poor miserable soul has to actually read it. Additionally, recognize that that poor miserable soul might know where you live, and not be so happy if you somehow wrote into existance a fucking spaghetti monster. Finally, comprehend that by spending 5 more minutes to add a few comments and update the API, it may save someone else on your team the amount of work equivilant decryto pting the enigma machine.

Ethan Pls

All of that being said, read our full documentation here.

promdate-docs's People

Contributors

jeffrey-dot-li avatar

Watchers

 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.