mirror of
https://github.com/bigchaindb/bigchaindb.git
synced 2024-10-13 13:34:05 +00:00
e681427b75
* Problem: The write-a-bep page/process is daunting Solution: Make the BEP writing process easier and more approachable * Problem: BEP should be written uppercase Solution: Change bigchaindb/BEPs label names to use uppercase "BEP"
15 lines
1.4 KiB
Markdown
15 lines
1.4 KiB
Markdown
# Write a BigchainDB Enhancement Proposal (BEP)
|
|
|
|
If you have an idea for a new feature or enhancement, and you want some feedback before you write a full BigchainDB Enhancement Proposal (BEP), then feel free to:
|
|
- ask in the [bigchaindb/bigchaindb Gitter chat room](https://gitter.im/bigchaindb/bigchaindb) or
|
|
- [open a new issue in the bigchaindb/BEPs repo](https://github.com/bigchaindb/BEPs/issues/new) and give it the label **BEP idea**.
|
|
|
|
If you want to discuss an existing BEP, then [open a new issue in the bigchaindb/BEPs repo](https://github.com/bigchaindb/BEPs/issues/new) and give it the label **discuss existing BEP**.
|
|
|
|
## Steps to Write a New BEP
|
|
|
|
1. Look at the structure of existing BEPs in the [bigchaindb/BEPs repo](https://github.com/bigchaindb/BEPs). Note the section headings. [BEP-2](https://github.com/bigchaindb/BEPs/tree/master/2) (our variant of the consensus-oriented specification system [COSS]) says more about the expected structure and process.
|
|
1. Write a first draft of your BEP. It doesn't have to be long or perfect.
|
|
1. Push your BEP draft to the [bigchaindb/BEPs repo](https://github.com/bigchaindb/BEPs) and make a pull request. [BEP-1](https://github.com/bigchaindb/BEPs/tree/master/1) (our variant of C4) outlines the process we use to handle all pull requests. In particular, we try to merge all pull requests quickly.
|
|
1. Your BEP can be revised by pushing more pull requests.
|