The Chakra Project

SVN and packaging policy

From The Chakra Project - Wiki

Jump to: navigation, search

Here are some easy rules for our beloved devs and maintainers, to make it easier for everyone to follow - at least i hope that. You should keep these rules in your mind and dont ignore them (!)

Contents

Editing PKGBUILDs

  • Always use the standard intendation of 8 = standard tabs. No fancy stuff required, also no spaces etc, just tabs. Hey, we are just editing small scripts, no fancy intendation rules needed. (Protip: Just use Kate and its builtin filelist plugin)
  • If a PKGBUILD requires special stuff (workarounds, sed lines), always document that with some comments.
  • If you include a workaround, mark it with WORKAROUND in a comment, so we can grep through it when someone has a fixing-spree or so
  • If you think something needs to be fixed, mark it with FIXME in a comment, so we can grep through it when someone has a fixing-spree or so
  • Dont modify the PKGBUILD layout because you think its better for you or improves "editability". PKGBUILDs should be rather readable and understandable than "easy to edit" for us devs...

Committing PKGBUILDs

  • Never commit something that does not work (!!!)
  • Test your changes before committing
  • Double-check what you commit before committing
  • Always write a proper description for your commits, just describe what you have done (no novels needed, just a useful description)...
  • If you do some big changes, announce them to the other devs in IRC or just write a mail - even better if you do it before committing, many eyes see more than just two ones :)

Uploading Packages

  • Always test the packages and the db before uploading

Modifying the buildsystem

  • Always talk to Phill (Amnon) before committing any changes to the _buildsystem directory, it could save your ass :) This especially concerns the makepkg script... If you need to edit the skel files for the builder to include a new kde module or so, just do it, these are easy stuff :)
Personal tools