docs(core): development & testing process

NYU-Processor-Design / nyu-core

The code and tests for the RISCV-32I compatible core for the NYU Processor Design VIP team.

Creative Commons Zero v1.0 Universal

2 stars 11 forks source link

docs(core): development & testing process #34

Closed umanachi closed 1 year ago

umanachi commented 1 year ago

let me know if there's too much/little, or if there's anything I am missing

codecov[bot] commented 1 year ago

Codecov Report

Merging #34 (4387a89) into main (4966c90) will not change coverage. The diff coverage is n/a.

@@            Coverage Diff            @@
##              main       #34   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            3         3           
  Lines           38        38           
=========================================
  Hits            38        38

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

ShinyMiraidon commented 1 year ago

Looks great so far. I would just add a section about best practices. You know stuff like using random number generation for testing inputs and things of that sort

ShinyMiraidon commented 1 year ago

Also this is not something you have to do for this pull request, but we should think about adding this and the module functionality documentation to the currently empty wiki