Hi Antoine, Thanks so much for your feedback. Gemfile.lock has no new changes except for the Windows platform specific changes.I wasn't sure if that should be committed.Regarding the gherkin dependency on multi_json part,would sure look into that. Thanks for reviewing the code and providing feedback. Am clear with the commit message now.
Regards, Jagori On Wed, Dec 10, 2014 at 8:09 PM, Antoine Musso <[email protected]> wrote: > Le 10/12/2014 08:46, jagori samajdar a écrit : > > Hi, > > > > I am confused regarding the commit messages which I should write for > > each individual patch submitted against an issue. > > > > This is in reference to the issue I had been working on: > > /https://gerrit.wikimedia.org/r/#/c/122400// > > > > My queries are as below: > > > > 1. Should a commit message say what changes I have done in a particular > > patch submitted against an issue or should it refer to the issue in > > general am working on?If I have reworked my code basis the inputs > > provided,then what should be my commit message? Like in my case > > :should it be "Add test for long external link" or should it be > > "Rework long external link code"[since I had reworked my code from > > the previous commit basis the inputs given] > > 2. How would I distinguish between individual commits? > > When your Gerrit change is ready and approved, only the LAST patchset is > going to land in the repository. All the intermediary patchsets would > only be in Gerrit and most probably never seen by other developers. > > If you want to comment about modifications between patchsets, use the > Gerrit comment to explain reviewers the difference. Ie the commit > message would most probably stay the same between patchsets. > > Your commit message should reflect what the change is about, in your > case: "Add test for long external link". > > > > 3. If I use WIP: in my commit message ,when should I remove that? If my > > work is awaiting feedback and approval from someone,should I keep > > WIP or is it if am confident enough of my code I should remove that?. > > As far as I know, using WIP in commit message is a convention used by > the VisualEditor project. I guess you can remove it once you are > confident your patch can land in, but better want to check with them. > > On other repositories, I usually vote CodeReview -1 on the Change > indicating it is not ready. > > > Overall, you might want to read about the commit message guidelines > recommendation: > https://www.mediawiki.org/wiki/Gerrit/Commit_message_guidelines > > > It is a good idea to describe the problem at hand, describe your design > choices and summarize the code change. Looking at your change > https://gerrit.wikimedia.org/r/#/c/122400/ , there is a few questions > which might be answered in the commit message: > > > What is this code about? > Why did you need to add in Gemfile.lock the x86-mingw32 platform? > Why does gherkin suddenly depends on multi_json? > > So you can come up with: > > ------------------------- > [browsertest] Test for shortened external link > > When a long external link is used in the VisualEditor content box, the > link is shortened when shown in the external link label. > > Add a new scenario to links.feature to enter a long URL and verify it > is shortened. > > // + Describe the Gemfile.lock changes > > ------------------------- > > > > -- > Antoine "hashar" Musso > > > _______________________________________________ > QA mailing list > [email protected] > https://lists.wikimedia.org/mailman/listinfo/qa >
_______________________________________________ QA mailing list [email protected] https://lists.wikimedia.org/mailman/listinfo/qa
