wiki:en/patches
developer.jelix.org is not used any more and exists only for history. Post new tickets on the Github account.
developer.jelix.org n'est plus utilisée, et existe uniquement pour son historique. Postez les nouveaux tickets sur le compte github.

Version 1 (modified by laurentj, 12 years ago) (diff)

--

Proposing a patch

You have to follow this steps, in order to create a patch.

  1. retrieve the last version of jelix (trunk) from the repository (and not from the download area !)
  2. create the ini file for the build script
  3. modify the sources of jelix in order to fix the bug you want to correct, or to made improvements
  4. build Jelix and build testapp
  5. test your changes and launch unit tests in the testapp application
  6. if not ok, back to the third step.
  7. all is ok, you can create the patch.

Details about this steps are described here, except the last one. Let's explain it.

The content of your patch

Your patch should contain all the modifications in the code, but it must all contains modifications in the headers of all files you changed: your name, your copyright etc. You should also update the lib/jelix/CREDITS files.

Creating the patch

In the directory of your local copy of the repository, you should have made all your changes. Go into the trunk directory and type:

svn diff > mypatch.diff

Then you have a mypatch.diff file.

Perhaps you should made same changes in other branches. Provide then a patch for these branches

Proposing the patch

Submit it into a ticket on developer.jelix.org. The ticket can be an existant one, or perhaps you have to create it. Create/edit the ticket and attached the file.

If your patch is not finished (because you haven't no more time to work on it for example), so add a comment to explain the situation, and then this is the end for you.

But if it is a finished patch, you should ask a review by setting the "review" field of the ticket to "review?". Then a reviewer will verify your patch. If it is ok, he will set "review+". If your patch needs some improvements, he will set "review-" and then you will have to make improvements he asked and you will create a new patch, submit it on the ticket, ask "review?" and so on.

When you have "review+", you can commit the patch in the repository if you have write acces, or a "commiter" will do it for you.

See to know the 'commit styles'?.


summary