Skip to content
This repository has been archived by the owner on Sep 7, 2024. It is now read-only.

feat: add guide to iip-template.md #10

Merged
merged 3 commits into from
Nov 19, 2023
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 62 additions & 0 deletions iip-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
iip: 0
title: IIP title
status: draft, standard
type: optional, required
author: name <[email protected]>
created: 2023-07-10
---

<!--
READ CONTRIBUTING.md BEFORE USING THIS TEMPLATE!

This is the suggested template for new IIPs. After you have filled in the requisite fields, please delete these comments.

Note that an IIP number _can_ be assigned by **you**. Please see CONTRIBUTING.md for more information.

The title should be 44 characters or less.

TODO: Remove this comment before submitting
-->

## Abstract

<!--
The Abstract is a multi-sentence (short paragraph) technical summary. This should be a very terse and human-readable version of the specification section. Someone should be able to read only the abstract to get the gist of what this specification does.

TODO: Remove this comment before submitting
-->

## Motivation

<!--
This section is optional.

The motivation section should include a description of any nontrivial problems the IIP solves. It should not describe how the IIP solves those problems, unless it is not immediately obvious. It should not describe why the IIP should be made into a standard, unless it is not immediately obvious.

TODO: Remove this comment before submitting
-->

## Specification

eznix86 marked this conversation as resolved.
Show resolved Hide resolved
<!--
The Specification section should describe the syntax and semantics of any new feature. The specification should be detailed enough to allow competing, interoperable implementations for any of the current Pactus platforms (besu, erigon, Pactusjs, go-Pactus, nethermind, or others).
kehiy marked this conversation as resolved.
Show resolved Hide resolved

It is recommended to follow RFC 2119 and RFC 8170. Do not remove the key word definitions if RFC 2119 and RFC 8170 are followed.

TODO: Remove this comment before submitting
-->

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119 and RFC 8174.

## [Additional Section]

<!--
REPLACE [Additional Section] TITLE WITH THE NAME OF YOUR SECTION.

This section is optional.

An additional section may include various subsections. One such subsection is the "Security Considerations" section, addressing potential security implications of the proposed changes.

TODO: Remove this comment before submitting
-->