Skip to content

Problem: The write-a-bep page/process is daunting#2347

Merged
ttmc merged 2 commits intobigchaindb:masterfrom
ttmc:improve-the-page-re-writing-beps
Jul 23, 2018
Merged

Problem: The write-a-bep page/process is daunting#2347
ttmc merged 2 commits intobigchaindb:masterfrom
ttmc:improve-the-page-re-writing-beps

Conversation

@ttmc
Copy link
Copy Markdown
Contributor

@ttmc ttmc commented Jun 12, 2018

Solution: Make the BEP writing process easier and more approachable

  • Give them options to float/propose an idea for a BEP, so they can get feedback on it before writing a full BEP.
  • Note that there's now an "official" way to discuss existing BEPs.
  • When it comes to writing the BEP, don't make them read BEP-1 and BEP-2 before doing anything. Suggest that they look at existing BEPs to get an idea of the expected structure.
  • They must write the BEP before making a pull request, so they don't have to read BEP-1 (our process for handling pull requests) until after they write their BEP.

@vrde - I know you're on vacation but I put you as a reviewer since I know you care about this. You can review it when you get back.

Problem: The write-a-bep page/process is daunting
1dc2067 
Solution: Make the BEP writing process easier and more approachable
@ttmc ttmc added the docs label Jun 12, 2018
@ttmc ttmc self-assigned this Jun 12, 2018
@ttmc ttmc requested review from codegeschrei, vrde and z-bowen June 12, 2018 09:50
@ttmc
Copy link
Copy Markdown
Contributor Author

ttmc commented Jun 12, 2018

I also switched to using terminology like "BEP-2" rather than "2/COSS," as suggested by issue bigchaindb/BEPs#32.

@codegeschrei
Copy link
Copy Markdown
Contributor

codegeschrei commented Jun 13, 2018

I like it!
Just a tiny style change. Is it maybe better to have 'BEP' always written all caps? Labels are case sensitive so it's possible.

Problem: BEP should be written uppercase
1fd9f57 
Solution: Change bigchaindb/BEPs label names to use uppercase "BEP"
@ttmc ttmc removed request for vrde and z-bowen July 23, 2018 08:41
@ttmc
Copy link
Copy Markdown
Contributor Author

ttmc commented Jul 23, 2018

@codegeschrei approved this PR so I will merge it now.

@ttmc ttmc merged commit e681427 into bigchaindb:master Jul 23, 2018
@ttmc ttmc deleted the improve-the-page-re-writing-beps branch July 23, 2018 08:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@codegeschrei codegeschrei codegeschrei approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@ttmc ttmc

Labels

docs

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@ttmc @codegeschrei