Lots of room to improve. Start with a README and CI.
Parallel Programming for FPGAs -- An open-source high-level synthesis book
Documentation
8
No install instructions found in the README (−45 pts).
→ Add a section showing how to install dependencies.
No license detected.
→ Add a LICENSE file. Without one, nobody can legally use, copy, or contribute to your code.
No CONTRIBUTING.md found (−47 pts base + up to −53 pts more for content).
→ Add a CONTRIBUTING.md telling newcomers how to get involved. Include setup, code style, test, and PR instructions.
README is present.
Engineering
0
No tests detected anywhere in the repository.
→ Add automated tests. They prove the code works and give contributors confidence to make changes.
No CI configuration detected in this repository.
→ If your CI lives elsewhere (a private repo that builds this one) or this project is itself a CI/CD tool, mark this check Not Applicable. Otherwise add a GitHub Actions workflow that runs tests on each push. It takes 15 minutes and reassures contributors their changes won't break things.
No linter or formatter config found.
→ Add a linter config such as .eslintrc.json, .prettierrc, ruff.toml, or .golangci.yml to enforce consistent code style.
No dependency lockfile found (−70 pts).
→ Commit the lockfile for this project's package manager so installs produce the same dependency versions everywhere.
No issue or PR templates found (−100 pts).
→ Add .github/ISSUE_TEMPLATE/ with bug_report.md and feature_request.md to guide contributors. It dramatically improves issue quality.
Project health
43
No dependency manifest detected at root.
→ Add a manifest (package.json, pyproject.toml, Cargo.toml, go.mod, etc.) so others can install dependencies in one command.
No pushes in over 2 years. Looks unmaintained (−95 pts).
→ A recent commit signals the project is alive and worth using.
Repository has a description.
.gitignore present.
Repository health signals
Activity, community, and responsiveness at scan time
Activity
- —Commits (30d / 90d)
- 0Forks
- 0Releases
Community
- —Community health
- —authors own >50% of commits
- 0Watchers
Responsiveness
- —Median issue response
- —Median PR merge time
- 0Open issues
Repository files78 root entries
- examples
- images
- labs
- .gitignoreGood: .gitignore present.
- acknowledgements.tex
- all.bib
- cookbook.tex
- cordic.tex
- cover.pdf
- cover.svg
- dft_behavior_baseline.svg
- dft_behavior_loop_pipeline.svg
- dft_behavior_loop_sequential.svg
- dft_behavior1.svg
- dft_behavior2.svg
- dft_behavior3.svg
- dft_project.tex
- dft_recurrence_behavior.svg
- dft-time-freq.svg
- dft.tex
- emulator.tex
- fft_dataflow_behavior.svg
- fft.tex
- fftstages.svg
- filter_asm_behavior.svg
- filter_one_sample_behavior.svg
- filter_one_sample.svg
- filter_one_tap_behavior.svg
- filter_one_tap.svg
- filter2d_results_boundary_conditions.svg
- filter2d_results_withshifting.svg
- fir_project.tex
- fir.tex
- glossary.tex
- huffman_encoding.tex
- intervalduration.svg
- intro.tex
- latencyduration.svg
- main.tex
- Makefile
- matmul_array_reshape.svg
- matrix_multiplication.tex
- matrix_vector_optimized.svg
- matrix_vector_partition_factor.svg
- matrix_vector_poor_scaling.svg
- matrix_vector_unroll_inner.svg
- merge_sort_restructured_behavior.svg
- number_representation.tex
- ofdm_project.tex
- onecolumn_template.svg
- phase_detector_project.tex
- preface.tex
- prefix_histogram.tex
- prefixsum_optimized_behavior.svg
- prefixsum_unrolled_behavior.svg
- prefixsumBO_behavior.svg
- projects.tex
- README.mdGood: README is present.Issue: README is very short (−20 pts). 400+ characters earns +10 pts; 1,500+ earns +20 pts.Fix: Add an Overview, Install, Usage, and Contributing section at minimum.Issue: README has little structure (−15 pts). Add 2-3 headings for +8 pts; 4+ earns +15 pts.Fix: Break it into sections (Overview, Install, Usage, Contributing) using Markdown headings.Issue: No screenshots or images in the README (−20 pts).Fix: Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.Issue: README has no code examples (−15 pts).Fix: Show a quick-start snippet so contributors can see what using your project looks like.Good: README links to a live demo or deployed app.Issue: No status badges in the README (−10 pts).Fix: Add CI/build status badges from shields.io or your CI provider to signal project health.Issue: No install instructions found in the README (−45 pts).Fix: Add a section showing how to install dependencies.Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
- restructured_mergesort_dataflow.svg
- sorting.tex
- sparse_matrix_vector.tex
- spmv_behavior.svg
- spmv_partial_unroll.svg
- spmv_unrolled_behavior.svg
- timeshapes.svg
- twocolumn_template.svg
- video_2dfilter.svg
- video_BRAM_interface.svg
- video_buffers.svg
- video_DDR_DMA_interface.svg
- video_DDR_interface.svg
- video_streaming_interface.svg
- video_syncs.svg
- video_timelines.svg
- video.tex
- videoScanlineOrder.svg
- wireless.tex
- wirelessBasics.tex