Discuss adding version and copyright info to each contract in OpenZeppelin Contracts

abcoathup · November 19, 2019, 10:51pm

github.com/OpenZeppelin/openzeppelin-contracts

Discuss adding version and copyright info to each contract

opened 10:39PM - 19 Nov 19 UTC

closed 10:18PM - 19 Oct 21 UTC

meta

**🧐 Motivation** More and more we see contracts being installed individually, i…nstead of as part of the npm package. A recent example is the VS code plugin extension by the Microsoft Azure blockchain team: this extension allows a user to choose a contract by name, and it just downloads the solidity file (and its dependencies) to a local folder. This has the problem that any project-wide information, such as copyright, license, or package version is lost. Though we could ask to every tool to add this information as they download the contracts, it may be easier to just add it at the source. **📝 Details** Add a comment header to every contract with something along the lines of: ```solidity /** * @openzeppelin/contracts@X.Y.Z * Copyright zOS Global Limited, licensed under MIT * See https://github.com/OpenZeppelin/openzeppelin-contracts/ */ ``` And modify the release script so the version identifier on each contract is automatically updated, possibly just by using `sed -i`.

Feel free to add to the discussion here or on GitHub.