Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Hardware libraries style guide #64

Open
nkrkv opened this issue Sep 12, 2018 · 1 comment
Open

Hardware libraries style guide #64

nkrkv opened this issue Sep 12, 2018 · 1 comment

Comments

@nkrkv
Copy link
Member

nkrkv commented Sep 12, 2018

As mentioned in #63 (comment):

We have a few conventions that are scattered through the docs or even unwritten.
For example:

We have a few conventions that are scattered through the docs or even unwritten.
For example:

  • any nodes that create a new type to work with hardware should be named as xxx-device
  • node that initialises hardware module should be named init
  • names of any nodes which do instructions "what to do" in imperative style must begin with a verb (init, read-byte, pair-tag, write-line, etc)
  • nodes that "unfold" complex types into more primitive ones are named unpack-xxx
  • example patches are named example-xxx
    (and probably a few others that I forgot to mention)

It will be cool to summarize these in a single guide article.

@brusherru
Copy link
Contributor

brusherru commented Sep 12, 2018

Also, do not forget to replace xxx-example with example-xxx in the guide Creating Libraries

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants