That sounds good with me. On Fri, Jul 22, 2016 at 1:54 AM Sijie Guo <[email protected]> wrote:
> Hello all, > > Since the git repo has been cloned to apache and also mirrored on GitHub, > we need to add a confluence page (we haven't moved the website yet) to > describe the workflow to manage the pull requests and merge the code > changes for both contributors and committers. > > I am thinking of two things: > > 1) cloning the workflow from other projects (e.g. bookkeeper, spark). > > > https://cwiki.apache.org/confluence/display/BOOKKEEPER/Contributing+to+BookKeeper > https://cwiki.apache.org/confluence/display/SPARK/Contributing+to+Spark > > The main points behind them are: > > - We will use JIRA for tracking issues, tasks and enhancements. > - We will use GitHub pull requests to reviews and a script to merge pull > requests. > - For trivial fixes, we can accept pull requests without creating JIRAs. > - Otherwise, JIRA (+discussion) are preferred before sending pull requests. > - A merge-pr script for committers to merge pull requests to apache git > repo. > > 2) maillist, confluence and website (documentation) > > It would be better to define a formal process for how we deal with the > changes and how we organize the documentation. Especially based on some > experiences with other open sources project, documentation tends to become > inconsistent between confluence pages and website (documentation). I'd like > to seek a solution to avoid this here. Here are some thoughts: > > Basically the knowledges (information) for changes/ideas should sort of > going in one direction and no back-forth bouncing between different places. > > Maillist -> Confluence pages -> Jiras -> Website (documentation) > > *Maillist*: Start an email thread for an idea or a proposal. It covers the > whole discussion and tracks the history. > *Confluence pages*: A confluences page reflects the current state for the > idea (proposal). Discussions and changes should go to maillist and be > reflected eventually in the confluence page. > *Jiras*: Jiras are used to track the tasks and implementation for the idea > (proposal). > *Website (documentation)*: The final design and implementation details > should be reflected on website on the completion of all the jiras. > > Any thoughts? > > - Sijie > -- -franck
