Skip to content

Latest commit

 

History

History
58 lines (38 loc) · 2.24 KB

proposal-template.md

File metadata and controls

58 lines (38 loc) · 2.24 KB
Raw

Contract Propoal

Preamble

Title: <Contract Name/Type:> <Upload Code/Instantiate Contract>
Author(s): <List of authors' names and/or email addresses and GitHub handles>
Contributors: <List of contributor's names and/or email addresses and GitHub handles>
Tags: <Contract/Code>
Status: <Assigned by  Editor>
Date Proposed: <yyyy-mm-dd>
Date Ratified: <yyyy-mm-dd>
License: <Sdded by Author>

References

  • A list of supporting materials referenced.

Summary

  • A short description of what the Proposal is focused on. Suggest 30 words max.

Abstract

  • A 3-5 sentence description of the full Propoal going through the contract that is to be added to the chain.

Motivation

  • A short description of the motivation behind creating the contract.

Specification

  • Proposed process standard details - describes the new process or feature.

Proposed Code

  • The final code or link to the reference or resources.

Test Cases

  • For the implementation or testing of the proposed code.

Security Considerations

  • This is one of the most important aspects of Contract Proposal. The purpose of this section is to proactively document any security-relevant design information, decisions, potential failure modes, implementation details, and important discussions related to the proposed. This section helps to optimize the process by providing proactive guidance on security considerations when proposing a change that will affect the persistence chain.

Auditor Information and Report

  • This section includes the audit partner details and the final audit report for the proposed code.

Licensing