Re: [edk2-announce] Research Request

[Jeremiah Cox <jerecox@microsoft.com>]

Feedback on GitHub as follows…


> 1. No Lock-In - What automated data export is available?
> We want to be able to leave and take all our data with us. "Data" here 
> includes: review comments, pull requests / patches (including metadata), 
> old (rejected) pull requests and metadata, issue tracker entries and 
> comments (if issue tracker included). This archiving should be 
> automated, not something we do by hand.

Untested, but might these all be easily satisfied by subscribing a mailing list to GitHub notifications?  
https://help.github.com/articles/about-notifications/#watching-notifications 
https://help.github.com/articles/about-email-notifications/ 

Alternatively, the GitHub REST API appear to offer full export capability of all information & metadata:
   https://developer.github.com/v3/git/commits/#get-a-commit 
   https://developer.github.com/v3/pulls/#list-pull-requests
   https://developer.github.com/v3/pulls/comments/#list-comments-on-a-pull-request
   https://developer.github.com/v3/issues/events/#list-events-for-a-repository
   https://developer.github.com/v3/issues/comments/#list-comments-on-an-issue 
   https://developer.github.com/v3/activity/events/#list-repository-events 
   https://developer.github.com/v3/reactions/#list-reactions-for-a-pull-request-review-comment 
   * the above allows you to export all of the thumbs up/down, smileys, hearts ... that users have given to pull request & issue comments  :)



> 2. Easy Administration - Are there any scripts or custom code required 
> after initial setup? We would like to do as little customizing as possible.

Our interpretation of this bullet is to maximize developer productivity & minimize deployment & operations costs.  
GitHub provides a ready-to-use, end-to-end solution. There are no servers for end-customers to patch & maintain.
GitHub is free for use by open source projects, and Microsoft is committed to continuing this tradition:
https://www.microsoft.com/en-us/Investor/events/FY-2018/Microsoft-and-GitHub-Conference-Call 
GitHub’s enormous user base has motivated numerous developers to generate GitHub Apps that further enhance the GitHub experience.  



> 3. Flexible Workflow - Can we use email patches / email review as well 
> as pull requests / web UI review?**
>   3a. Can we can attach review comments to specific code *and* commit 
> message locations?
>   3b. Are the comments faithfully translated to notification emails 
> (including the locations in code the comment is addressing)?
>   3c. Are old topic branches (rejected or updated pull requests) 
> available even after being rejected? (i.e. are they ever deleted?)
>   3d. Is plain text supported in code review comments?
> **To be clear, it is acceptable if the system handles only pull requests 
> and a web UI. We do require, however, a *read-only* email notification 
> system that thoroughly documents our process.

We propose that all review & issue tracking are through GitHub web, REST, or Graph APIs.  Email becomes read-only for notification and archival only.
3A:  Yes.
3B:  From our testing this appears to be yes.
3C:  GitHub can be configured to keep rejected and updated pull requests.  
3D:  Both plain text and markdown work



Some additional questions we feel are important:


*  Does the workflow facilitate automated validation & PR-Gates?  
GitHub: Yes
Phabricator:  https://secure.phabricator.com/T9456 : “Writing lots of integrations for third-party software is broadly something the upstream is not well equipped for.”
Travis-CI further declined support for Phabricator: https://github.com/travis-ci/travis-ci/issues/2143#issuecomment-124150608 “we have no immediate plans to add this feature”


*  Does workflow allow easy contribution process?  
GitHub:  Yes, well-known and well-documented


* Does it have comprehensive documentation?
GitHub:  Yes


*  Does it have a comprehensive programmatic API that enables extensibility, with numerous online examples?
GitHub:  Yes 


*  Does workflow facilitate different server-enforced policies for different branches?
GitHub:  Yes 



Sincerely,
Jeremiah Cox


-----Original Message-----
From: stephano <stephano.cetola@linux.intel.com> 
Sent: Tuesday, November 20, 2018 4:59 PM
To: Jeremiah Cox <jerecox@microsoft.com>
Cc: edk2-devel@lists.01.org; Sean Brogan <sean.brogan@microsoft.com>
Subject: Re: [edk2] [edk2-announce] Research Request

Thank you both for taking the time to add some insight to our discussions. Please see the list of questions here:

https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Flists.01.org%2Fpipermail%2Fedk2-devel%2F2018-November%2F032462.html&amp;data=02%7C01%7Cjerecox%40microsoft.com%7Caace5779691047a1809b08d64f4c7fb2%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C636783587312509548&amp;sdata=sra5nI19QTGmCbkDBeR7QYFTVpndqZqCjzkmhO0nlsU%3D&amp;reserved=0

These are a summary from our community meetings.

Enjoy the holiday!

Cheers,
Stephano

On 11/20/2018 3:47 PM, Jeremiah Cox wrote:
> Hi Stephano,
> Sean and I will put something together for GitHub by next Tuesday.
> 
> Thank you,
> Jeremiah Cox  (departing for Thanksgiving holiday... now...)
> 
> -----Original Message-----
> From: edk2-devel <edk2-devel-bounces@lists.01.org> On Behalf Of 
> stephano
> Sent: Wednesday, November 14, 2018 10:34 AM
> To: edk2-devel@lists.01.org
> Subject: [edk2] [edk2-announce] Research Request
> 
> We are currently researching several different options to help make contributing to TianoCore easier for the community. A big part of this effort will be enabling pull requests and allowing for a more customizable code review process.
> 
> I am looking for members of the community willing to answer a few questions about these solutions to allow us to evaluate our options quickly. The options are:
> 
> System/Tool		Investigator
> Phabricator		Rebecca Cran (thank you again :) )
> Github			???
> Gerrit			???
> Gitlab			???
> 
> I have a list of questions that I can send out to each investigator.
> Assuming you are familiar with the software/system, these questions should be answerable with a couple hours of research, writing, and screenshots / examples.
> 
> Thanks in advance for your help!
> 
> -Stephano
> 
> _______________________________________________
> edk2-devel mailing list
> edk2-devel@lists.01.org
> https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Flists
> .01.org%2Fmailman%2Flistinfo%2Fedk2-devel&amp;data=02%7C01%7Cjerecox%4
> 0microsoft.com%7Caace5779691047a1809b08d64f4c7fb2%7C72f988bf86f141af91
> ab2d7cd011db47%7C1%7C0%7C636783587312509548&amp;sdata=SOR9cdCLwmsl37RB
> S0fkk6a%2FIE1so1flDYG2%2BzjCBbQ%3D&amp;reserved=0
>