Re: [cxs] Swagger / REST endpoint workflow proposal

[Serge Huber <shuber@jahia.com>]

I think one of the benefits Chris forgot to mention was to be able to keep a history of potential discussions on pull requests. For example yesterday we did this query language proposal and it would be cool to keep a record of the discussions around it directly in a pull request. Another way of doing it would be to use issue tracking but I’m not sure how well it would work. 

If we come to the conclusion that this hinders progress then maybe we should only do it for “large” changes. But I think that Chris was also hoping that this would encourage offline work too :) 

cheers,

  Serge.. 

On 15 juin 2016, at 18:06, Christophe Laprun <claprun@jahia.com> wrote:

Hi folks,

I was thinking about how we could improve our workflow while working on the swagger specification and thought that it might be interesting to leverage Github's Pull Request mechanism to gather work and keep an history of what’s been done along with comments and decisions. For example, each workgroup could clone the “official” swagger document and create a pull request for each work item. We would then vote and discuss the issues using github before merging the PRs to the official version. This would also help record alternative ideas and facilitate the review process during monthlies. Another benefit would be to allow working on the spec in a more asynchronous way (providing we each could find time to work on it outside of scheduled meetings).

What do you think?

Best regards,

Christophe Laprun
Senior Software Engineer

8 rue du Sentier | 75002 Paris | France

jahia.com

SKYPE | LINKEDIN | TWITTER | VCARD

> JOIN OUR COMMUNITY to evaluate, get trained and to discover why Jahia is a leading User Experience Platform (UXP) for Digital Transformation.