search

OpenST / developer-guidelines

Guidelines on code, project setup, etc.
MIT License
3 stars 8 forks source link

Update solidity style guide wrt documenting an author for a contract #33

Open pgev opened 5 years ago

pgev commented 5 years ago

Currently, solidity style guide in this repo mentions the followings:

Avoid using @author documentation tag.

In the context of this ticket, please update documentation and let developer to add @author ethereum NatSpec tag for contracts and interfaces in the following format:

@author John Doe - <email@example.com>