search

nss-lean-anteaters / nutshell

2 stars 0 forks source link

PR Template #9

Open Deanna2000 opened 6 years ago

Deanna2000 commented 6 years ago

Link to Ticket

Closes # [Link]()

Description of Proposed Changes

Steps to Test

Outline the steps to test

git fetch --all
git checkout <feature_branch>

Impacted Areas in Application

List general components of the application that this PR will affect:

Mentions @username

Tag users that need to review this code

Definition of Done

  1. The project must be fully documented. This includes the following:
    1. Complete README that documents the steps to install the code, how to install any dependencies, or system configuration needed.
    2. Every class must be documented with purpose, author, and methods.
    3. Every method must be documented with purpose and argument list - which itself must contain a short purpose for each argument.
  2. The project must be able to run fully, and without errors, on each teammate's system.
  3. Fulfills every requirement. Every line of code has been peer reviewed.
  4. For projects that require unit testing, core functionality must be identified and have at least one test for each.