Versions Compared

Old Version 13

changes.mady.by.user Joe Brockmeier

Saved on

compared with

New Version Current

changes.mady.by.user Animesh

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 4.0

<DRAFT WORK IN PROGRESS>

We review code patches to ensure that submissions are relevant, good quality and following the coding guidelines and best practices.

...

The submitter completes the work flow once the patch has been committed by changing the state to "Submitted" manually Image Added

Responsibilities

...

  • Make sure your patches apply cleanly when posted for review
  • Test that the the patch actually works and indicate what testing has been performed. e.g. Documentation patches should be built with Publican before submitting a patch.  A good reference for what we mean by actually works is to look at the project's Branch Merge Expectations page.
  • Respond to review comments and provide an updated patch incorporating the feedback
  • Make sure to follow up on your patches. If they do not get reviewed and committed within 3 days, send an email to reviewers and dev mailing list.
  • Do not mark your patch as "Ship It" yourself, that is expected to be marked by reviewer if he/she is satisifed with your patch
As a Committer
  • Respond to reviews timely when you are asked to review a patch
  • Follow up with submitter if they do not respond to your comments
  • It’s not enough to say “Ship It”. You have to actually apply the patch. Once you have applied the patch update the review with commit details.
  • Actively look out for any reviews that are pending over a week and review it if falls in your area of expertise, if not ask another committer who is more appropriate to review the change
Acknowledging contribution

Since we use git as our version control it is encouraged that contributors use git format-patch to generate their patches.  This allows the community to attribute the code contribution to the author of the patch. It also makes it easy for the contributors to be elected as committers when the PMC notices all the valuable contributions from their patches. For patches that don't come in with author information committers are requested to amend the author information (git commit --author) before pushing to help acknowledge the contribution.