Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Problem: Current shortnames weird/hard-to-remember #51

Merged
merged 4 commits into from
Jul 29, 2018
Merged
Show file tree
Hide file tree
Changes from all 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
2 changes: 1 addition & 1 deletion 1/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
```
shortname: 1/C4
shortname: BEP-1
name: Collective Code Construction Contract
type: Meta
status: Draft
Expand Down
2 changes: 1 addition & 1 deletion 10/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
```
shortname: 10/SAAR
shortname: BEP-10
Name: A Strangler Application Approach to Rewriting Some Code in Go
type: Informational
status: Raw
Expand Down
4 changes: 2 additions & 2 deletions 12/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
```
shortname: 12/TX-SPEC-1
shortname: BEP-12
name: BigchainDB Transactions Spec v1
type: Standard
status: Stable
Expand All @@ -26,7 +26,7 @@ It was also implemented by several BigchainDB drivers. We may make a complete li

# Change Process

The process to change this document is [2/COSS](../2/README.md) (COSS).
The process to change this document is [BEP-2 (COSS)](../2/README.md).

# Specification

Expand Down
4 changes: 2 additions & 2 deletions 13/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
```
shortname: 13/TX-SPEC-2
shortname: BEP-13
name: BigchainDB Transactions Spec v2
type: Standard
status: Stable
Expand Down Expand Up @@ -54,7 +54,7 @@ For the reasoning, see [bigchaindb/bigchaindb#1937](https://github.com/bigchaind

# Change Process

The process to change this document is [2/COSS](../2/README.md) (COSS).
The process to change this document is [BEP-2 (COSS)](../2/README.md).

# Specification

Expand Down
6 changes: 3 additions & 3 deletions 14/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
```
shortname: 14/GIDR
shortname: BEP-14
name: Guidelines to Improve Drivers Reliability
type: standard
status: raw
type: Standard
status: Raw
editor: Alberto Granzotto <alberto@bigchaindb.com>
contributors: Lev Berman <ldmberman@gmail.com>
```
Expand Down
2 changes: 1 addition & 1 deletion 17/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
```
shortname: 17/AZURE-1
shortname: BEP-17
name: Listing BigchainDB in Azure Marketplace, Phase 1
type: Standard
status: Raw
Expand Down
7 changes: 3 additions & 4 deletions 18/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
```
shortname: [18/TEP]
shortname: BEP-18
name: Transactional Election Process
type: standard
status: draft
type: Standard
status: Draft
editor: Alberto Granzotto <alberto@bigchaindb.com>
contributors: Vanshdeep Singh <vanshdeep@bigchaindb.com>, Lev Berman <lev@bigchaindb.com>
```


# Transactional Election Process

## Abstract
Expand Down
2 changes: 1 addition & 1 deletion 19/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
```
shortname: 19/tm_stress
shortname: BEP-19
Name: Tendermint Performance Profiling
type: Informational
status: Raw
Expand Down
8 changes: 4 additions & 4 deletions 2/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
```
shortname: 2/COSS
shortname: BEP-2
name: Consensus-Oriented Specification System
type: Meta
status: Draft
Expand All @@ -12,7 +12,7 @@ This document describes a consensus-oriented specification system (COSS) for bui
This specification is based on [unprotocols.org 2/COSS](https://rfc.unprotocols.org/spec:2/COSS/) and on [EIP1 - EIP Purpose and Guidelines](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1.md).

## Change Process
This document is governed by the [2/COSS](../2/README.md) (COSS).
This document is governed by the [BEP-2 (COSS)](../2/README.md) (COSS).

## Language
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 [BCP 14](https://tools.ietf.org/html/bcp14) \[[RFC2119](https://tools.ietf.org/html/rfc2119)\] \[[RFC8174](https://tools.ietf.org/html/rfc8174)\] when, and only when, they appear in all capitals, as shown here.
Expand Down Expand Up @@ -48,7 +48,7 @@ There are three types of BEPs:
* A **Meta BEP** describes a process surrounding BigchainDB or proposes a change to a process.

### BEP Format
A BEP is a set of Markdown documents (the main file SHOULD be called `README.md`), together with comments, attached files, and other resources. A BEP is identified by its number and short name (e.g. this BEP is **2/COSS**). The number of the BEP is also the name of the directory where its files are stored.
A BEP is a set of Markdown documents (the main file SHOULD be called `README.md`), together with comments, attached files, and other resources. A BEP is identified by its number (e.g. this BEP is **BEP-2**). The number of the BEP is also the name of the directory where its files are stored.

Every BEP (including branches) carries a different number. New versions of the same BEP have new numbers.

Expand Down Expand Up @@ -82,7 +82,7 @@ Each BEP SHOULD include the following sections:

1. **Implementation**. The implementations must be completed before any BEP is given status "stable", but it need not be completed before the BEP is accepted. While there is merit to the approach of reaching consensus on the BEP and rationale before writing code, the principle of "rough consensus and running code" is still useful when it comes to resolving many discussions of API details.

1. **Copyright Waiver**. Except for 1/C4 and 2/COSS, all BEPs MUST be released to the public domain. The following waiver SHOULD be used: _To the extent possible under law, the person who associated CC0 with this work has waived all copyright and related or neighboring rights to this work._
1. **Copyright Waiver**. Except for BEP-1 (C4) and BEP-2 (COSS), all BEPs MUST be released to the public domain. The following waiver SHOULD be used: _To the extent possible under law, the person who associated CC0 with this work has waived all copyright and related or neighboring rights to this work._

The first 4 sections above are based on the [Leslie Lamport's note about describing solutions](https://lamport.azurewebsites.net/pubs/state-the-problem.pdf).

Expand Down
2 changes: 1 addition & 1 deletion 20/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
```
shortname: 20/BOUNTY
shortname: BEP-20
name: Bounties in BigchainDB
type: Meta
status: Raw
Expand Down
6 changes: 3 additions & 3 deletions 21/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
```
shortname: [21/UPSERT-VALIDATORS]
shortname: BEP-21
name: Dynamically add/update/remove validators at runtime
type: standard
Status: raw
type: Standard
Status: Raw
editor: Vanshdeep Singh <vanshdeep@bigchaindb.com>
```

Expand Down
2 changes: 1 addition & 1 deletion 3/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
```
shortname: 3/UPSERT-VALIDATORS
shortname: BEP-3
name: Dynamically add/update/remove validators at runtime
type: standard
status: stable
Expand Down
2 changes: 1 addition & 1 deletion 4/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
```
shortname: 4/STANDARDIZE-DC
shortname: BEP-4
name: Standard process to set up a local node for development & testing, using Docker Compose
type: standard
status: raw
Expand Down
6 changes: 3 additions & 3 deletions 42/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
```
shortname: [42/HARD-FORKS]
shortname: BEP-42
name: Handling new transaction models and storage schemas
type: information
Status: raw
type: Informational
Status: Raw
editor: Vanshdeep Singh <vanshdeep@bigchaindb.com>
```

Expand Down
4 changes: 2 additions & 2 deletions 5/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
```
shortname: 5/IDRP
shortname: BEP-5
name: Illegal Data Response Plan
type: Informational
status: raw
Expand Down Expand Up @@ -200,7 +200,7 @@ So we dropped it. Maybe we are too nice. Dogmatism got in the way of pragmatism.

## Can I Suggest an Improvement to This BEP?

BigchainDB GmbH has a process to improve BEPs like this one. Please see [BEP-1/C4](https://github.com/bigchaindb/BEPs/blob/master/1) and [BEP-2/COSS](https://github.com/bigchaindb/BEPs/blob/master/2).
BigchainDB GmbH has a process to improve BEPs like this one. Please see [BEP-1 (C4)](https://github.com/bigchaindb/BEPs/blob/master/1) and [BEP-2 (COSS)](https://github.com/bigchaindb/BEPs/blob/master/2).

Your consortium might have a variation of the IDRP. Your consortium can modify its variant using it's own governance processes.

Expand Down
3 changes: 1 addition & 2 deletions 6/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# Shared Workspace Protocol
```
shortname: 6/SWP
shortname: BEP-6
name: Shared Workspace Protocol
type: Meta
status: Draft
Expand Down
4 changes: 2 additions & 2 deletions 7/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
```
shortname: 7/PUBLIC-API
shortname: BEP-7
name: Definition of the BigchainDB Public API
type: Informational
status: raw
status: Raw
editor: Troy McConaghy <troy@bigchaindb.com>
```

Expand Down
6 changes: 3 additions & 3 deletions 8/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
```
shortname: 8/CRASH-RECOVERY
shortname: BEP-8
name: Restore system state after crash
type: standard
status: raw
type: Standard
status: Raw
editor: Vanshdeep Singh <vanshdeep@bigchaindb.com>
```

Expand Down
62 changes: 32 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,41 +3,43 @@
This is the BigchainDB Enhancement Proposal project. We collect BEPs for APIs, protocols, and processes.

The process to add or change a BEP is the following:
- A BEP is created and modified by pull requests according to [C4](./1).
- BEP lifecycle SHOULD follow the lifecycle defined in [COSS](./2).

- A BEP is created and modified by pull requests according to [BEP-1 (our variant of C4)](./1).
- The BEP life-cycle SHOULD follow the life-cycle defined in [BEP-2 (our variant of COSS)](./2).
- Non-cosmetic changes are allowed only on [Raw](./2#raw-beps) and [Draft](./2#draft-beps) specifications.

# Current BEPs

Short Name | Title | Type | Status | Editor
--------------|--------------------------------------------------------------|----------|------------|-------
[1/C4](1) | Collective Code Construction Contract | Meta | Draft | Alberto Granzotto
[2/COSS](2) | Consensus-Oriented Specification System | Meta | Draft | Alberto Granzotto
[3/UPSERT-VALIDATORS](3) | Dynamically add/update/remove validators at runtime | Standard | Stable | Vanshdeep Singh
[4/STANDARDIZE-DC](4) | Standard process to set up a local node for development & testing, using Docker Compose | Standard | Raw | Muawia Khan
[5/IDRP](5) | Illegal Data Response Plan | Informational | Raw | Troy McConaghy
[6/SWP](6) | Shared Workspace Protocol | Meta | Draft | Alberto Granzotto
[7/PUBLIC-API](7) | Definition of the BigchainDB Public API | Informational | Raw | Troy McConaghy
[8/CRASH-RECOVERY](8) | Restore system state after crash | Standard | Raw | Vanshdeep Singh
[10/SAAR](10) | A Strangler Application Approach to Rewriting Some Code in Go | Informational | Raw | Alberto Granzotto
[11/PYTHON-ORM-DRIVER](11) | ORM Implementation For Official BigchainDB Python Driver | Standard | Raw | Manan Patel
[12/TX-SPEC-1](12) | BigchainDB Transaction Spec v1 | Standard | Stable | Troy McConaghy
[13/TX-SPEC-2](13) | BigchainDB Transaction Spec v2 | Standard | Stable | Troy McConaghy
[14/GIDR](14) | Guidelines to Improve Drivers Reliability | Standard | Raw | Alberto Granzotto
[17/AZURE-1](17) | Listing BigchainDB in Azure Marketplace, Phase 1 | Standard | Raw | Troy McConaghy
[18/TEP](18) | Transactional Election Process | Standard | Draft | Alberto Granzotto
[19/TM-STRESS](19) | Tendermint Performance Profiling | Informational | Raw | Zach Bowen
[20/BOUNTY](20) | Bounties in BigchainDB ecosystem | Meta | Raw | Chalid Mannaa
[21/UPSERT-VALIDATORS](21) | Dynamically add/update/remove validators at runtime | Standard | Raw | Vanshdeep Singh

# Current Participants

## Contributors
## Current BEPs

Short Name | Title | Type | Status | Editor
-------------|---------------------------------------------------------------|----------|------------|-------
[BEP-1](1) | Collective Code Construction Contract | Meta | Draft | Alberto Granzotto
[BEP-2](2) | Consensus-Oriented Specification System | Meta | Draft | Alberto Granzotto
[BEP-3](3) | Dynamically add/update/remove validators at runtime | Standard | Stable | Vanshdeep Singh
[BEP-4](4) | Standard process to set up a local node for development & testing, using Docker Compose | Standard | Raw | Muawia Khan
[BEP-5](5) | Illegal Data Response Plan | Informational | Raw | Troy McConaghy
[BEP-6](6) | Shared Workspace Protocol | Meta | Draft | Alberto Granzotto
[BEP-7](7) | Definition of the BigchainDB Public API | Informational | Raw | Troy McConaghy
[BEP-8](8) | Restore system state after crash | Standard | Raw | Vanshdeep Singh
[BEP-10](10) | A Strangler Application Approach to Rewriting Some Code in Go | Informational | Raw | Alberto Granzotto
[BEP-11](11) | ORM Implementation for Official BigchainDB Python Driver | Standard | Raw | Manan Patel
[BEP-12](12) | BigchainDB Transaction Spec v1 | Standard | Stable | Troy McConaghy
[BEP-13](13) | BigchainDB Transaction Spec v2 | Standard | Stable | Troy McConaghy
[BEP-14](14) | Guidelines to Improve Drivers Reliability | Standard | Raw | Alberto Granzotto
[BEP-17](17) | Listing BigchainDB in Azure Marketplace, Phase 1 | Standard | Raw | Troy McConaghy
[BEP-18](18) | Transactional Election Process | Standard | Draft | Alberto Granzotto
[BEP-19](19) | Tendermint Performance Profiling | Informational | Raw | Zach Bowen
[BEP-20](20) | Bounties in the BigchainDB Ecosystem | Meta | Raw | Chalid Mannaa
[BEP-21](21) | Dynamically add/update/remove validators at runtime | Standard | Raw | Vanshdeep Singh
[BEP-42](42) | Handling new transaction models and storage schemas | Informational | Raw | Vanshdeep Singh

## Current Participants

### Contributors

- Anyone who wants to contribute
- The whole [BigchainDB Team in Berlin](https://github.com/orgs/bigchaindb/people)

## Maintainers
### Maintainers

Everyone with the ability to merge pull requests. Today that is mainly BigchainDB employees.

Expand All @@ -51,7 +53,7 @@ Some people have specializations:
- Docker, Kubernetes, NGINX: Shahbaz, Muawia
- Docs: Troy

## Administrators (Founders and Others)
### Administrators (Founders and Others)

- Kamal - @GataKamsky
- Gautaum - @gautamdhameja
Expand Down