[vtk-developers] Newbie developer

[David E DeMarle]

Welcome to VTK!

Sorry for the delayed response Ghyslain, the developers are all quite
busy. I am sure you are too, so know I mean it when I say, thanks for
contributing!

First, make sure you've run Utilities/SetupForDevelopment.sh so that you
get the gerrit remote and sanity checking scripts in place.

Next, start your work off of either the master or release branches. The
advantage of starting from release is that it makes it easier to get the
code into the next official release. The disadvantage is that over time,
master diverges from the release branch point and it can become harder to
merge your change in to master to have it automatically regression tested.
Right now I'ld say:
> git checkout master; git pull; git checkout -b some_name_for_your_topic

(note, if you use XXXXX-topic-name, where XXXXX is the corresponding bug
number in mantis, mantis automatically adds notes when you commit)

Next, make your changes, check that it does what you want it to, run the
regression tests, and then commit it locally.
> make changes; manual test; ctest; git add files_you_changed; git commit

  (Note: it helps to run ctest on master locally to make sure your build is
alright before this. You should expect 95% or more of the tests to pass. If
you see worse than that, check the dashboards to see if something is up
with that day's master and if not be assured it is something on your build.)

Next, (since you've run SetupForDevelopment) run:
> git-gerrit-push
to share your topic with the world. This pushes the topic to the gerrit git
server, where we all can see and review your change. (note any gerrit
review comment with #XXXXX in it gets tracked automatically by the bug
tracker too.)

Now you've got to get your work tested and reviewed.

For safety reasons, we don't automatically merge or even compile and run
regression tests on submitted code. So the trick is that you've got to get
the attention of an approved developer. Try a:
> git log --follow
on the files you've changed to see who might be a good person to review the
change. Add that person as a reviewer in gerrit. If that fails, ping the
developers mailing list and ask someone for a review with the url of your
gerrit topic.

Eventually the reviewer(s) will look at the change and perhaps ask you to
submit additional changes. Make those on the same topic and push them to
gerrit as before. Once the reviewer thinks its OK to do so, they will make
a comment on the topic in gerrit that says "request build" to will trigger
quick regression tests of the topic on mac, windows and linux. If those
turn out alright, the reviewer will merge your change into master, again
through gerrit.

Once your change is in master you have to watch the continuous and nightly
sections of the dashboard for a day or to. To see if any problems snuck by
the quick gerrit checks. If something does turn up, make your fixes on the
same topic and push them as above.

HTH and welcome to the party.








David E DeMarle
Kitware, Inc.
R&D Engineer
21 Corporate Drive
Clifton Park, NY 12065-8662
Phone: 518-881-4909


On Mon, Jun 3, 2013 at 4:11 PM, Ghyslain Leclerc <ghleclerc at gmail.com>wrote:

> Hello to all.
>
> First mail here, so my apologies if it is out of place.  Tried (maybe not
> successfully) to follow the advice on the wiki about asking good questions.
>  I would also like to apologize in advance for my English, as it is not my
> first language.  Please be patient with me.  With that out of the way...
>
> I am a mostly self-taught programer.  My true profession is a medical
> physicist.  At work, we are currently (happily, thanks for the library by
> the way) using VTK to develop some applications.  Whenever we build
> programs linking to VTK, we have a ton of deprecation warnings whenever we
> include IO classes header vtkIOstream.h.  All those warnings sometimes
> obscure other deprecation warnings that we would like to know about and so
> we would like to see them disappear.
>
> I made a Mantis bug report (0014036) about it which is not assigned to
> anyone.  Realizing that you might not have the time to fix this seemingly
> unimportant bug / annoyance, I set out to try and fix it myself.  I feel
> this would let me give back a (very) little bit to the community.  So I got
> a Gerrit account, setup git, my ssh key and then cloned VTK and VTKData as
> is recommended in the Wiki.
>
> Unfortunately, I am now stumped.  I cannot understand what branch or topic
> I should try to put my work into.  Is there a step-by-step tutorial that I
> can follow for my situation ?  Is there someone who would like to invest
> the time to get me up and running.  I am also uncertain as to what the
> procedure would be for me to submit my work for evaluation.
>
> Sorry if this is not the right place to ask such basic questions.
>
> In any case, thanks.
>
> Ghyslain
> _______________________________________________
> Powered by www.kitware.com
>
> Visit other Kitware open-source projects at
> http://www.kitware.com/opensource/opensource.html
>
> Follow this link to subscribe/unsubscribe:
> http://www.vtk.org/mailman/listinfo/vtk-developers
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://public.kitware.com/pipermail/vtk-developers/attachments/20130618/0ad6b707/attachment.html>