Preparing contribution of plug-in to Qt Creator

[mloskot]

As it is explained in the README/FAQ, originally I wasn't going to contribute the plug-in to Qt Creator, but @jhunold suggested (#8 and #12) it would be beneficial for the plug-in if it is maintained as part of Qt Creator.

Let's discuss what it takes, tasks and steps needed, to submit the plug-in to Qt Creator.
I have also announced this issue on Qt Creator ML: Preparing to contribute Boost.Build Plugin to Qt Creator

AFAIU, according to the guidelines I've found, here is the procedure and related issues:
0. Basically, follow Qt Contribution Guidelines

1. Build Qt Creator using the repository from Gerrit, then build the plug-in against such build.
2. Setting up Gerrit
3. Follow the Qt Creator Plug-in Contribution Guide, where I see a few issues:

• What does merge request on gitorious.org mean? Andre Poenitz from Qt clarified that this is completely outdated nonsense. He'll try to correct it. All Qt and Qt Creator code submissions need go through gerrit (codereview.qt-project.org) for quite some time.
• Presumably, coding standard conformance is deal breaker, becasue I did neither follow Qt Coding Qt Creator Coding Rules. If I'm asked to restructure and reformat the plug-in codebase, it's going to be a time issue.
• There is tangible commitment by the submitter to help maintain the code, as the Qt Creator Plug-in Contribution Guide suggests, but I can't make hard promises. @jhunold would you be willing to join me?

The points 2 and 3 are not a mystery, so I will proceed, but it is not clear to me how to perform the actual code submission to Qt Creator for review. Would you be available to help and clarify, @jhunold?

[jhunold]

Hi Mateusz,
of course I can help out with both maintenance and first getting the plugin into creator. So we can share the maintenance load.
On point 3:
I think you only have to put the module inside Qt-Creators plugin structure and submit a Gerrit review request containing the added files. That would be:

1. Move the code to src/plugins/boostbuild
2. git add -A src/plugins/boostbuild
3. push to Gerrit
4. wait for comments
5. fix issues
6. goto 3 until accepted.

We can probably clone the (in-)official mirror at https://github.com/qtproject/qt-creator and prepare everything. This includes integration into QtCreator's build system as a first-class citizen, renaming the .hpp files to .h and fixing the coding style. The latter can be enforced/assistet by QtCreator itself, I hope.
We can then prepare a squashed commit for submission into Gerrit. This is how I would tacklet the problem with my (limited) experience with Gerrit.

[mloskot]

Jürgen, the steps you outlined look sensible. I didn't know we can clone from the mirror at GitHub. I double checked and it actually is mentioned as one of possible sources indeed:
http://qt-project.org/wiki/Setting-up-Gerrit#bf8aa9648651d4dab8aafb6408a51427
I'm gone for the weekend, so I'll kickstart the process next week.

Thanks for offering your help.

[jhunold]

Hi Mateusz,
any chance you can at least fork QtCreator and import your code to "plugins/boostbuildprojectmanager/" ? Those interestet could then start from there and clenaup the code.

[mloskot]

@jhunold I've cleaned my desk enough to move forward with the submission.
I've forked Qt Creator in https://github.com/mloskot/qt-creator, but I've also learned about some caveats of development outside the Gerrit, see section Feature development outside of Gerrit.
They strongly recommend Gerrit. What we do?

[jhunold]

I've already signed the CLA so this should not be a problem. Let's see what happens with our ML discussion and then decide. I'm short on free time this week anyway. I hope to finish #12 next and then proceed. Some naming ideas:

• the plugin directory should be name "boostbuildprojectmanager" I guess.
• we should name the files b2foo.h and b2foo.cpp if this is allowed.

[mloskot]

Great. Yes, let's wait for some conclusive response (there is this new thread QtCreator plugin contribution), where I also asked about the GitHub-based workflow and which branch to branch off. Qt Wiki is being still clarified.

• the plugin directory should be name "boostbuildprojectmanager" I guess.

Agreed.
(FYI, I'd prefer to keep this GitHub repository named as it is now, qt-creator-plugin-boostbuild - it makes it clear what is the project about).

• we should name the files b2foo.h and b2foo.cpp if this is allowed.

Agreed.

[mloskot]

Concrete pros/cons suggestion arrived in that thread, that a wip (work in progress) branch on Qt Gerrit is the better choice.

I'm inclined to go for it as I will have to set up the damn Gerrit anyway :)
What's your final call, @jhunold?

[jhunold]

Decision time again. I'm all for the wip branch approach. This really allows us to work with maximal feedback toward a working longtime solution. I simply did not think of this option for a 3rdparty addin. Can you please ask for a "wip/boostbuildprojectmanager" branch on the ML?

[mloskot]

👍 Following the long-lived branches guidelines I've sent request to the Gerrit Administrators (CC'ed to you too).

[mloskot]

We've got the branch wip/boostbuildprojectmanager created.

Last night, I've finished setting up Gerrit in fresh Qt/Qt Creator clones. Still need to learn more about the Gerrit workflow. Posted some additional questions in the Preparing to contribute Boost.Build Plugin to Qt Creator thread.

[mloskot]

Everything that wasn't clear to me has been clarified now, see http://lists.qt-project.org/pipermail/qt-creator/2015-April/004593.html.
IMO, we're ready to do initial import of the current sources in Gerrit and start cleaning up.

@jhunold Are you OK if I do the import?

[jhunold]

I've tracked the discussion on the QtCreator ML. You can start working in gerrit if you like. I'm just very short on time this week, thing should be getting better next week.

[mloskot]

No worries. I was only asking for confirmation.
Turns out, I may not be able to touch the import until after the weekend.

[mloskot]

Finally, I've pushed initial Change to the Gerrit.

Here is the direct link generated by git gpush command: https://codereview.qt-project.org/#/c/111340/
It is also accessible from the list of my open Changes.
Let's get the party started :)

The initial TODO items, also outlined in the commit message, are:

• Adjust coding style to follow Qt Creator/Qt guidelines
• Rename the files to replace "bb" prefix with "b2" as in b2foo.{h|cpp}
• Catch up with any Qt Creator API changes and fix building issues.

Before I rename the files and do any further changes, I'll wait a day or two in case Qt Creator devs would have any initial feedback for us.