lowRISC / lowRISC/opentitan

[util/design] Create a make-ip script that generates directory structure and boilerplate files

Open
#5,177 4 comments 0 reactions 1 assignee View on GitHub

Nobody has claimed this yet.

Earlgrey-PROD Triaged Good First Issue Help Wanted Priority:P3 Type:Enhancement Type:FutureRelease
Dominant language
SystemVerilog
Stars
3.6k
Forks
1.1k
Avg merge
2d 22h
Merged PRs (30d)
141

Description

It would be really nice to have a simple make-comportable-ip script that automatically creates the directory structure and basic files needed (similar to how fpvgen, uvmdvgen or make_new_dif work). This would make the process of creating a new comportable IP a bit less cumbersome and faster, since we currently just manually copy these files over from other existing IPs.

Files that could be generated with such a script:

  • prj.hjson
  • example hjson
  • checklist markdown
  • documentation markdown
  • fusesoc core file
  • empty lint waivers
  • empty RTL shell

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.