Skip to content

Commit

Permalink
Fix incomplete paragraphs. Inconsistencies
Browse files Browse the repository at this point in the history
  • Loading branch information
jackalyst committed Jul 4, 2023
1 parent a3820c7 commit e827c98
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 13 deletions.
2 changes: 1 addition & 1 deletion README.md
Expand Up @@ -31,6 +31,6 @@ Other important documents include:

# Special thanks

QRL Improvement Proposals (QIP) have been heavily influenced by Ethereum Improvement Proposals (EIPs) and Bitcoin Improvement Proposals (BIPs), with some modification in areas to fit the needs of the QRL project.
QRL Improvement Proposals (QIP) have been heavily influenced by [Ethereum Improvement Proposals (EIPs)](https://github.com/ethereum/EIPs/) and [Bitcoin Improvement Proposals (BIPs)](https://github.com/bitcoin/bips), with some modification in areas to fit the needs of the QRL project.

A special thanks goes out to Ethereum and Bitcoin for being so seminal to blockchain and decentralized governance.
23 changes: 15 additions & 8 deletions qip-specification.md
Expand Up @@ -20,9 +20,10 @@
- [6. Comments URI](#6-comments-uri)
- [7. Comments URI Summary](#7-comments-uri-summary)
- [8. Created](#8-created)
- [9. Requires](#9-requires)
- [10. Replaces](#10-replaces)
- [11. Superseded By](#11-superseded-by)
- [9. Modified](#9-modified)
- [10. Requires](#10-requires)
- [11. Replaces](#11-replaces)
- [12. Superseded By](#12-superseded-by)

# 1. QIP

Expand Down Expand Up @@ -119,7 +120,9 @@ The author of the QIP.

# 5. Layer

QRL Improvement Proposals consists of
QRL Improvement Proposals are for core improvements, either to the network or security layers. This can be described as `core`, `core/networking` or `core/security`. Most use `core`.

There is also a `meta` layer, which is for structural changes to the QIP Process, governance, and structure.

# 6. Comments URI

Expand All @@ -131,16 +134,20 @@ Full URI of the comment summary made after the proposals review process.

# 8. Created

Date that the draft was created
Date that the draft was created.

# 9. Modified

Date that the QIP was modified.

# 9. Requires
# 10. Requires

The QIPs that this QIP depends on, by UUID.

# 10. Replaces
# 11. Replaces

The QIPs that this QIP replaces, by UUID

# 11. Superseded By
# 12. Superseded By

The QIPs that supersedes
5 changes: 3 additions & 2 deletions qip-template.md
Expand Up @@ -7,6 +7,7 @@ status: <draft[/incomplete,/abandoned,/withdrawn], proposals[/open,/under_discus
comments_uri: <to be assigned at pull request stage>
comments_summary_uri: <to be assigned at proposals/(accepted, or rejected) stage>
created: <ISO 8601 creation date (yyyy-mm-dd)>
updated: <ISO 8601 updated date (yyyy-mm-dd)>
requires: <QIP number(s),> (optional)
replaces: <QIP number(s),> (optional)
superseded_by: <QIP number(s), URI> (optional)
Expand All @@ -31,7 +32,7 @@ The motivation section should describe the "why" of this QIP. What problem does

The technical specification 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 QRL platforms to integrate.

### Rationale
## Rationale

The rationale fleshes out the specification by describing what motivated the design and why particular design decisions were made. It should describe alternate designs that were considered and related work, e.g. how the feature is supported in other languages.

Expand All @@ -41,7 +42,7 @@ All QIPs that introduce backwards incompatibilities must include a section descr

## Reference Implementation

An optional section that contains a reference/example implementation that people can use to assist in understanding or implementing this specification. If the implementation is too large to reasonably be included inline, then consider adding it as one or more files in
An optional section that contains a reference/example implementation that people can use to assist in understanding or implementing this specification. If the implementation is too large to reasonably be included inline, then consider adding it as one or more files as under the qips directory named after your padded qip number (ie QIP001/) or including a link to your repository.

## Security Considerations

Expand Down
2 changes: 1 addition & 1 deletion qip-workflow.md
Expand Up @@ -111,7 +111,7 @@ git remote add upstream https://github.com/theQRL/qips
For smoother editing, a local jekyll site can be built.

1. Open terminal
2. Install [rvenv](https://github.com/rbenv/rbenv), if you haven't done so already.
2. Install [rbenv](https://github.com/rbenv/rbenv), if you haven't done so already.
3. Install local Ruby version

```bash
Expand Down
2 changes: 1 addition & 1 deletion qips/reference.md
Expand Up @@ -40,7 +40,7 @@ All QIPs that introduce backwards incompatibilities must include a section descr

## Reference Implementation

An optional section that contains a reference/example implementation that people can use to assist in understanding or implementing this specification. If the implementation is too large to reasonably be included inline, then consider adding it as one or more files in
An optional section that contains a reference/example implementation that people can use to assist in understanding or implementing this specification. If the implementation is too large to reasonably be included inline, then consider adding it as one or more files as under the qips directory named after your padded qip number (ie QIP001/) or including a link to your repository.

## Security Considerations

Expand Down

0 comments on commit e827c98

Please sign in to comment.