Skip to content

Commit

Permalink
docs: process updates (#60)
Browse files Browse the repository at this point in the history
  • Loading branch information
Kristjan Kosic authored and faustbrian committed Jan 31, 2019
1 parent 15b4ce8 commit 188af84
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 15 deletions.
4 changes: 2 additions & 2 deletions AIP-template.md
Expand Up @@ -4,6 +4,7 @@
Authors: *Firstname LastName <email@domain.com>*
Status: *Draft, Rejected or Active*
Discussions-To: https://github.com/arkecosystem/AIPS/issues
Address: *Ark address used to collect votes for the specific AIP*
Type: *Standards (Core, Networking, Interface, Consensus)/Process/Informational*
Category *only required for Standards Track: <Core | Networking | Interface | Consensus>
Created: *YYYY-MM-DD*
Expand Down Expand Up @@ -35,8 +36,7 @@ The rationale should provide evidence of consensus within the community and disc
## Backwards Compatibility
All AIPs that introduce backwards incompatibilities must include a section describing these incompatibilities and their severity. The AIP must explain how the author proposes to deal with these incompatibilities. AIP submissions without a sufficient backwards compatibility treatise may be rejected outright.

## Refer ?
ence Implementation
## Reference Implementation
The reference implementation must be completed before any AIP is given status "Final", but it need not be completed before the AIP is accepted. It is better to finish the specification and rationale first and reach consensus on it before writing code.

The final implementation must include test code and documentation appropriate for the Ark protocol.
28 changes: 17 additions & 11 deletions AIPS/aip-1.md
Expand Up @@ -2,15 +2,16 @@
AIP: 1
Title: AIP Purpose and Guidelines
Author: Kristjan Kosic <kristjan@ark.io> - based on BIPS/BIP-0001
Discussions-To: https://github.com/arkecosystem/AIPS/issues
Discussions-To: https://github.com/arkecosystem/AIPS/issues/1
Address: ATLjjUopfBChLq3ujiFxBxUKYfJiWfu4MN
Status: Draft/WIP
Type: Process
Created: 2019-01-10
</pre>

# What is a AIP?

AIP stands for Ark Improvement Proposal. A AIP is a design document providing information to the Ark community, or describing a new feature for Ark or its processes or environment. The AIP should provide a concise technical specification of the feature and a rationale for it.
AIP stands for Ark Improvement Proposal. AIP is a design document providing information to the Ark community, or describing a new feature for Ark or its processes or environment. The AIP should provide a concise technical specification of the feature and a rationale for it.

We intend AIPs to be the primary mechanisms for proposing new features, for collecting community input on an issue, and for documenting the design decisions that have gone into Ark. The AIP author is responsible for building consensus within the community and documenting dissenting opinions.

Expand All @@ -21,30 +22,32 @@ Because the AIPs are maintained as text files in a GitHub repository, their revi
There are three kinds of AIP:

* Standards Track AIP describes any change that affects mostly Ark core implementations, such as a change to the network protocol, a change in block or transaction validity rules, or any change or addition that affects the interoperability of applications. Standard track also defines category (Core, Networking, Interface, Consensus).

* Informational AIP describes Ark's design issue, or provides general guidelines or information to the community, but does not propose a new feature. Informational AIPs do not necessarily represent a community consensus or recommendation, so users and implementors are free to ignore Informational AIPs or follow their advice.

* Process AIP describes a process surrounding Ark, or proposes a change to (or an event in) a process. Process AIPs are like Standards Track AIPs but apply to areas other than the Ark protocol itself. They may propose an implementation, but not to Ark's code-base; they often require community consensus; unlike Informational AIPs, they are more than recommendations, and users are typically not free to ignore them. Examples include procedures, guidelines, changes to the decision-making process, and changes to the tools or environment used in Ark development. Any meta-AIP is also considered a Process AIP.

# AIP Work Flow

The AIP process begins with a new idea for Ark. Each potential Ark must have a champion - someone who writes the AIP using the style and format described below, shepherds the discussions in the appropriate forums, and attempts to build community consensus around the idea. The AIP champion (a.k.a. Author) should first attempt to ascertain whether the idea is AIP-able. Sharing the idea or discussion on our slack channel is the best way to go about this.
The AIP process begins with a new idea for Ark. Each potential Ark must have a champion - someone who writes the AIP using the style and format described below, shepherds the discussions in the appropriate forums, and attempts to build community consensus around the idea. The AIP champion (a.k.a. Author) should first attempt to ascertain whether the idea is AIP-able. Sharing the idea or discussion on our slack channel is the best way to go about this. Best way to share and idea and also receive an AIP number is to open a new issue on this repository. Issue number correlates directly to your new AIP number (if it comes to it's realization).

Vetting an idea publicly before going as far as writing a AIP is meant to save both the potential author and the wider community time. Many ideas have been brought forward for changing Ark that have been rejected for various reasons. Asking the community first if an idea is original helps prevent too much time being spent on something that is guaranteed to be rejected based on prior discussions (searching the Internet does not always do the trick). It also helps to make sure the idea is applicable to the entire community and not just the author. Just because an idea sounds good to the author does not mean it will work for most people in most areas where Ark is used. Small enhancements or patches often don't need standardization between multiple projects; these don't need a AIP and should be injected into the relevant development work flow with a patch submission to the our git-hub page in the form of a Pull Request.

AIP authors are responsible for collecting community feedback on both the initial idea and the AIP before submitting it for review. However, wherever possible, long open-ended discussions on public mailing lists should be avoided. Strategies to keep the discussions efficient include: opening up a separate AIP discussion issue for the topic.

It is highly recommended that a single AIP contain a single key proposal or new idea. The more focused the AIP, the more successful it tends to be. If in doubt, split your AIP into several well-focused ones.

The Ark Team editors assign AIP numbers and change their status. The AIP editor reserves the right to reject AIP proposals if they appear too unfocused or too broad.
The AIP editor reserves the right to reject AIP proposals if they appear too unfocused or too broad.

Authors MUST NOT self assign AIP numbers, but should use an alias such as "AIP-champion-consensus-improvements" which includes the author's name/nick and the AIP subject.
Authors MUST NOT self assign AIP numbers, but should use the number of the new opened issues, serving as a AIP discussion link, as a number of the new AIP.

If the AIP editor approves, he will assign the AIP a number, label it as Standards Track, Informational, or Process, give it status "Draft". The AIP editor will not unreasonably deny a AIP. Reasons for denying AIP status include duplication of effort, disregard for formatting rules, being too unfocused or too broad, being technically unsound, not providing proper motivation or addressing backwards compatibility. For a AIP to be accepted it must meet certain minimum criteria. It must be a clear and complete description of the proposed enhancement. The enhancement must represent a net improvement. The proposed implementation, if applicable, must be solid and must not complicate the protocol unduly.
The AIP editor will not unreasonably deny a AIP. Reasons for denying AIP status include duplication of effort, disregard for formatting rules, being too unfocused or too broad, being technically unsound, not providing proper motivation or addressing backwards compatibility. For a AIP to be accepted it must meet certain minimum criteria. It must be a clear and complete description of the proposed enhancement. The enhancement must represent a net improvement. The proposed implementation, if applicable, must be solid and must not complicate the protocol unduly.

The AIP author may update the Draft as necessary in the git repository. Updates should be submitted by the author as pull requests.

Standards Track AIPs consist of two parts, a design document and a reference implementation. The AIP should be reviewed and accepted before a reference implementation is begun, unless a reference implementation will aid people in studying the AIP. Standards Track AIPs must include an implementation - in the form of code, a patch, or a URL to same - before it can be considered Final.

Once a AIP has been accepted, the reference implementation must be completed. When the reference implementation is complete and accepted the status will be changed to "Final".
Once a AIP has been accepted, the reference implementation must be completed. When the reference implementation is complete and accepted the status will be changed to "Final".

An AIP can also be assigned status "Deferred". The AIP author or editor can assign the AIP this status when no progress is being made on the AIP. Once a AIP is deferred, the AIP editor can re-assign it to draft status.

Expand Down Expand Up @@ -95,7 +98,8 @@ Each AIP must begin with an RFC 822 style header preamble. The headers must appe
AIP: <AIP number>
Title: <AIP title>
Author: <list of authors' real names and optionally, email addrs>
* Discussions-To: <AIP issue link>
* Discussions-To: <AIP issue link to the open issue related to the AIP>
* Address: <ATLjjUopfBChLq3ujiFxBxUKYfJiWfu4MN - Ark Mainnet address, used for voting and showing support>
Status: <Draft | Active | Accepted | Deferred | Rejected |
Withdrawn | Final | Superseded>
Type: <Standards Track | Informational | Process>
Expand Down Expand Up @@ -127,6 +131,9 @@ The Created header records the date that the AIP was assigned a number.

AIPs may have a Requires header, indicating the AIP numbers that this AIP depends on.

Address field is used to collect votes by the community, showing their support and wishes on what should be build first.
>Votes are a sign of priority, but the Ark team decides on the priority and technical specification of implementation.
AIPs may also have a Superseded-By header indicating that a AIP has been rendered obsolete by a later document; the value is the number of the AIP that replaces the current document. The newer AIP must have a Replaces header containing the number of the AIP that it rendered obsolete.

## Auxiliary Files
Expand All @@ -145,7 +152,7 @@ The AIP editor subscribes to the Ark's AIPs github notifications. For each new A

* Read the AIP to check if it is ready: sound and complete. The ideas must make technical sense, even if they don't seem likely to be accepted.
* The title should accurately describe the content.
* The AIP draft must have open discussion to the AIPs github as an open issue with correct naming.
* The AIP must have open discussion to the AIPs github as an open issue with correct naming.
* Motivation and backward compatibility (when applicable) must be addressed.
* The defined Layer header must be correctly assigned for the given specification.
* Licensing terms must be acceptable for AIPs.
Expand All @@ -156,7 +163,6 @@ Once the AIP is ready for the repository it should be submitted as a "pull reque

The AIP editor will:

* Assign a AIP number in the pull request.
* Merge the pull request when it is ready.
* List the AIP in AIP list.

Expand All @@ -167,6 +173,6 @@ The AIP editors are intended to fulfill administrative and editorial responsibil
This document was derived heavily from Bitcoin's BIP-0001 and BIP-0002. In many places text was simply copied and modified. Previous authors are not responsible for its use in the Ark Improvement Process, and should not be bothered with technical questions specific to Ark or the AIP process. Please direct all comments to the AIP editors or the Ark official slack.

# Changelog

31 Jan 2019 - Adding new numbering rules and Address Header to AIP proposals.
11 Jan 2019 - Added initial version, forked from BIP-0001 BIPS proposals.

2 changes: 1 addition & 1 deletion AIPS/aip-29.md
@@ -1,7 +1,7 @@
---
AIP: 29
Title: Generic Transaction Interface
Authors: *Brian Faust*
Authors: *Brian Faust, Kristjan Kosic, Joshua Noack*
Status: *Draft*
Discussions-To: https://github.com/arkecosystem/AIPS/issues
Type: *Standards Track*
Expand Down
7 changes: 6 additions & 1 deletion README.md
@@ -1,7 +1,12 @@
![Ark Improvement Proposals](assets/img/AIP_Header.png)

# Contributing
First review the [AIP-1-Process Guidelines for submitting an AIP](AIPS/aip-1.md). Then clone the repository and add your AIP to it, by following the [AIP-Template](AIP-template.md) structue. Before submiting a pull request to the official repository try to obtain consensus from the communty and the team (best place in official slack). Next step would be to submit a Pull Request to Ark's [AIPs repository](https://github.com/ArkEcosystem/AIPs). When your Pull Request is merged you will continue to work on the AIP together with the AIP editor.
- First review the [AIP-1-Process Guidelines for submitting an AIP](AIPS/aip-1.md).
- Open a new issue. The number assigned to the issue will be also your AIP number.
- Clone the repository and add your AIP to it. Follow the [AIP-Template](AIP-template.md) structure and guidelines.
- Submit a Pull Request to Ark's [AIPs repository](https://github.com/ArkEcosystem/AIPs). Before submitting a pull request to the official repository try to obtain consensus from the community and the team (discussion log under opened issue).

When your Pull Request is merged you will continue to work on the AIP together with the AIP editor.

# Current AIPs
| Number | Title | Author | Type | Layer | Status / Discussion |
Expand Down

0 comments on commit 188af84

Please sign in to comment.