Git Product home page Git Product logo

cs207project-1's Introduction

CS207 Project

Build Status

Coverage Status

Project Workflow

Code Review

For substantial project tasks, two people will be assigned.

Person 1 is the actual implementer, and will write basic test functions for their code.

Person 2 will review the code of Person 1, and write additional test functions as needed.

Comment Standards

According to PEP 8 docstrings should be included

for all public modules, functions, classes, and methods. Docstrings are not necessary for non-public methods, but you should have a comment that describes what the method does. This comment should appear after the def line.

At our October 21 group meeting, we decided to make sure we have comments

  1. at the start of a class definition (to explain the purpose of the class)
  2. within the constructor (i.e., the __init__() definition (to explain nonobvious aspects of object construction)
  3. at the start of user-facing functions (to explain nonobvious aspects of function construction)

Regular comments (i.e., those preceded by #) are brief in-line comments to fellow developers to help understand how the code works.

cs207project-1's People

Contributors

atsoroka avatar brennan-ae avatar cocochrane avatar jsm09 avatar sanoke avatar yaminibansal 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.