reading-notes

Reading Notes for Codefellows!

---

Project maintained by AlanYHung Hosted on GitHub Pages — Theme by mattgraham

Code 401 ASP.NET

Reading 02

(All My Notes are attributed/sourced from the Resources directly preceding them.)

Summary

• Unit Testing is the practice of setting up a framework that tests pieces of your code to ensure that those pieces function as expected. This will help you in recognizing what types of Exception Handling is needed that may have been missed and/or help with debugging your code for logical type errors that you may not have considered while coding.
• There are 6 best practices to follow when unit testing:
  1. Arrange, Act, Assert
  2. One Assert Per Test Method
  3. Avoid Test Interdependence
  4. Keep It Short, Sweet, and Visible
  5. Recognize Test Setup Pain as a Smell
  6. Add Them to the Build
• The README is for both consumers and developers alike. The README is a road map to your program. It will begin by telling the user how to setup and run your code and end with resource links that can help the user understand your program better. Along the way the README will let the user know what your program does, what problem your program is solving, and the contents of your program.
• The following is a checklist to help you with constructing a README:

    * One-liner explaining the purpose of the module
    * Necessary background context & links
    * Potentially unfamiliar terms link to informative sources
    * Clear, runnable example of usage
    * Installation instructions
    * Extensive API documentation
    * Performs cognitive funneling
    * Caveats and limitations mentioned up-front
    * Doesn't rely on images to relay critical information
    * License

Resources

• You Still Don’t Know How to Do Unit Testing (and Your Secret is Safe with Me)

  • Author: Erik Dietrich

  • Article Source

• Art of Readme

  • Author: Noffle (GitHub)

  • Article Source

• ReadMe Best Practices

  • Author: Jehna (GitHub)

  • Article Source

<– Back