This is an automated email from the ASF dual-hosted git repository.
sijie pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/bookkeeper.git
The following commit(s) were added to refs/heads/master by this push:
new b8dee21 Update the BP workflow
b8dee21 is described below
commit b8dee21a253f4d6f449e53afa5596cc6c54b189c
Author: Sijie Guo <[email protected]>
AuthorDate: Tue Dec 5 16:53:13 2017 -0800
Update the BP workflow
Descriptions of the changes in this PR:
- incorporate the feedback from JV last week: allow people to use google
doc for writing a BP. Google doc is great for collaboration in general.
- incorporate Ivan's comment on workflow #761 : how to handle failed BPs.
The principle here is BPs are in general good ideas, we should keep those
records for future references. so add an instruction on merging the failed BPs.
Author: Sijie Guo <[email protected]>
Reviewers: Ivan Kelly <[email protected]>
This closes #810 from sijie/fix_bp_workflow
---
.github/PULL_REQUEST_TEMPLATE.md | 3 +++
site/community/bookkeeper_proposals.md | 49 ++++++++++++++++++++++------------
2 files changed, 35 insertions(+), 17 deletions(-)
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 6b28945..566e18f 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -2,6 +2,8 @@ Descriptions of the changes in this PR:
(PR description content here)...
+Master Issue: #<master-issue-number>
+
> ---
> Be sure to do all of the following to help us incorporate your contribution
> quickly and easily:
@@ -12,6 +14,7 @@ Descriptions of the changes in this PR:
> `<BP-#>: Description of bookkeeper proposal`
> `e.g. BP-1: 64 bits ledger is support`
> - [ ] Attach the master issue link in the description of this PR.
+> - [ ] Attach the google doc link if the BP is written in Google Doc.
>
> Otherwise:
>
diff --git a/site/community/bookkeeper_proposals.md
b/site/community/bookkeeper_proposals.md
index 35a6ae8..434ec1a 100644
--- a/site/community/bookkeeper_proposals.md
+++ b/site/community/bookkeeper_proposals.md
@@ -44,27 +44,42 @@ Here is the process for making a BP:
- Take the next available BP number from this page.
- Write a brief description about what BP is for in this issue. This issue
will be the master issue for tracking the status of this BP and its
implementations.
All the implementations of this BP should be listed and linked to this
master issues.
-1. Write the proposal for this BP.
- - Make a copy of the
[BP-Template](https://github.com/apache/bookkeeper/tree/master/site/bps/BP-template.md).
Name the BP file as `BP-<number>-[caption-of-proposal].md`.
- ```shell
- $ cp site/bps/BP-template.md site/bps/BP-xyz-capation-of-proposal.md
- ```
- - Fill the sections listed in the BP template.
- - issue: replace `<issue-number>` with the issue number.
- - state: "Under Discussion"
- - release: leave the release to `N/A`. you can only mark a release
after a BP is implemented.
+1. Write the proposal for this BP. There are two ways to write a bookkeeper
proposal. You can choose to write a BP using markdown, or write a BP
+using Google Doc.
+ - Markdown
+ - Make a copy of the
[BP-Template](https://github.com/apache/bookkeeper/tree/master/site/bps/BP-template.md).
Name the BP file as `BP-<number>-[caption-of-proposal].md`.
+ ```shell
+ $ cp site/bps/BP-template.md site/bps/BP-xyz-capation-of-proposal.md
+ ```
+ - Fill the sections listed in the BP template.
+ - issue: replace `<issue-number>` with the issue number.
+ - state: "Under Discussion"
+ - release: leave the release to `N/A`. you can only mark a release
after a BP is implemented.
+ - Google Doc
+ - Make a copy of the
[BP-Template](https://docs.google.com/document/d/1DsmH54LoohgwqnEjESPQNtIYxxcOy2rwonZ_TJCwws0).
Name the BP file as `BP-<number>-[caption-of-proposal]`.
+ - Fill the sections listed in the BP template.
1. Send a PR for this BP. Following the instructions in the pull request
template.
- - add `BP` label to this BP
+ - add `BP` label to this PR
+ - attach the google doc link in the PR description if the BP is written in
google doc
- don't associate this PR with any release or milestone
+ - edit `site/community/bookkeeper_proposals.md`:
+ - bump the next bp number
+ - add this BP to `Inprogress` section
1. You can tag committers on this RP for reviewers, or start a `[DISCUSS]`
thread on Apache mailing list. If you are sending an email, please make sure
that the subject
of the thread is of the format `[DISCUSS] BP-<number>: capation of
bookkeeper proposal`.
1. Once the BP is finalized, reviewed and approved by committers, the BP is
accepted. The criteria for acceptance is [lazy
majority](http://bookkeeper.apache.org/bylaws.html).
-1. Committers merge the PR after a BP is accepted. The development for this BP
moves forward with implementations. The BP should be updated if there is
anything changed during
- implementing it.
-1. After all the implementations for a given BP are completed, a new PR should
be sent for changing the state of a BP:
- - state: "Adopted"
- - release: set to the release that includes this BP.
-1. The final PR for changing BP state will be used as the criteria for marking
a BP as completed.
+ 1. Committers merge the PR after a BP is accepted. The development for
this BP moves forward with implementations. The BP should be updated if there
is anything changed during implementing it.
+ 1. After all the implementations for a given BP are completed, a new PR
should be sent for changing the state of a BP:
+ - state: "Adopted"
+ - release: set to the release that includes this BP.
+ - moving the BP from `Inprogress` to `Adopted`.
+ 1. The final PR for changing BP state will be used as the criteria for
marking a BP as completed.
+1. If a BP is failed or rejected:
+ 1. Update the PR to change the state of a BP
+ - state: "Discarded"
+ - add a paragraph at the first paragraph of this BP for describing the
reasons.
+ - moving the BP from `Inprogress` to `Discarded`.
+ 2. Once the PR is updated, committers can merge this proposal PR and close
the master issue of this BP.
## All Proposals
@@ -82,7 +97,6 @@ Proposal | State
[BP-14 Relax
durability](https://cwiki.apache.org/confluence/display/BOOKKEEPER/BP-14+Relax+durability)
| Accepted
[BP-16: Thin Client - Remove direct metadata storage access from
clients](https://cwiki.apache.org/confluence/display/BOOKKEEPER/BP-16%3A+Thin+Client+-+Remove+direct+metadata+storage+access+from+clients)
| Draft
[BP-18: LedgerType, Flags and
StorageHints](https://cwiki.apache.org/confluence/display/BOOKKEEPER/BP-18%3A+LedgerType%2C+Flags+and+StorageHints)
| Accepted
-[BP-20: Github workflow for bookkeeper
proposals](../../bps/BP-20-github-workflow-for-bookkeeper-proposals) | Under
Discussion
### Adopted
@@ -99,6 +113,7 @@ Proposal | Release
[BP-13 - Time Based Release
Plan](https://cwiki.apache.org/confluence/display/BOOKKEEPER/BP-13+-+Time+Based+Release+Plan)
| 4.6.0
[BP-15 - New CreateLedger
API](https://cwiki.apache.org/confluence/display/BOOKKEEPER/BP-15+New+CreateLedger+API)
| 4.6.0
[BP-17 - Define BookKeeper public http
endpoints](https://cwiki.apache.org/confluence/display/BOOKKEEPER/BP-17%3A+Define+BookKeeper+public+http+endpoints)
| 4.6.0
+[BP-20: Github workflow for bookkeeper
proposals](../../bps/BP-20-github-workflow-for-bookkeeper-proposals) | 4.7.0
### Discarded
--
To stop receiving notification emails like this one, please contact
['"[email protected]" <[email protected]>'].
