Diff for "Contributors"

1. Contributing to RPM Fusion

So, you've decided to become a contributor to RPM Fusion? This guide will lead you through your first package submission and teach you how to update your package(s) in the future.

2. Becoming a RPM Fusion contributer

Having packaging experience in Fedora is much preferred, but newcomers are welcome too. However if you are a newcomer you must first get sponsored, that is find someone to guide you while you learn the ropes.

2.1. Create a Bugzilla Account

In either scenario you should create your first RPM Fusion package and submit this for review as described below. The review process is handled through bugzilla as will any bugs reported against your packages.

Make sure you have an account in Bugzilla.

The email address that you use for your bugzilla account should be the same email address as you use for all things related to RPM Fusion.

2.2. Join the Mailing List

Once this is done join the RPM Fusion mailing list (and, optionally, the freeworld graphics mailing list) and introduce yourself there. Include a link to the review request for your first package in your introduction, and if you're a newcomer also mention that you need someone to sponsor you.

If you have questions about the packaging process, this is the place to ask.

Also join the RPM Fusion subversion mailing list (missing link). The subversion mailing list is used for commit messages for our Subversion repository. You should subscribe to this list to track the changes to our packages.

3. Submitting a new package

3.1. Read the packaging guidelines

RPM Fusion follows the Fedora packaging guidelines, make sure you've read and understood these:

• http://fedoraproject.org/wiki/Packaging/NamingGuidelines

• http://fedoraproject.org/wiki/Packaging/Guidelines

It is also a good idea to read the items which will be checked during the review of your package and to verify yourself that these are all ok:

• http://fedoraproject.org/wiki/Packaging/ReviewGuidelines

3.2. Create a package review request

Before posting a review request, you should upload your SRPM and SPEC file to any accessible location on the internet.

Before your package can become part of RPM Fusion it must first be reviewed, goto https://bugzilla.rpmfusion.org/ and create a new bug:

• choose "Infrastructure" as product
• choose "Review Requests" as Component
• set Summary to: "Review request: %{name} - %{summary} Where %{name} and %{summary} come from the specfile
• Put the following in the description:
  • full URLs to the specfile and the SRPM for the new package
  • a short description for the package (hint use %description from the spec)
  • why this package is not eligible as a regular Fedora package
  • rpmlint output from running rpmlint on both the SRPM and RPM's built from it. Explain for each rpmlint message why you've chosen to ignore it.
  • mention if this is your first RPM Fusion package.

• The request should also be set to block the tracker bug: RF_NEW (#2). Other contributers can easily check for packages that need reviewing. If you want to help others by doing reviews yourself go to: https://bugzilla.rpmfusion.org/show_bug.cgi?id=2

3.3. Wait for your package to be reviewed

As time permits another RPM Fusion contributer will review your package, sometimes other people add a few comments, this does not constitute a review.

When a real / full review gets done the reviewer will assign the bug to him, remove the blocker on RF_NEW (#2) and set it to block the tracker bug: RF_REVIEW (#3). This indicates that a review is in progress. A review request should only be accepted by a maintainer that has at least one package in the RPM Fusion repository.

The reviewer should follow the Fedora Review Guidelines as close as possible, obviously taking into account any differences between Fedora and RPM Fusion. As RPM Fusion is more permissive with the content it allows, exceptions to these guidelines are allowed in some circumstances but care and common sense should prevail. The reviewer should ensure that any deviations from the Fedora Packaging Guidelines are sane and justified in the package they are reviewing. If in doubt, please ask on the RPM Fusion mailinglist. The reviewer should inform the contributor of any changes that need to be made to their package, if any. The contributor should update their package as necessary, including bumping the release version and submit the new SPEC file and SRPM URL. The reviewer should verify the changes. This is repeated as many times as necessary until the contributor and reviewer are happy with the final package.

3.4. Your package gets approved

If your improved version is okay the reviewer will approve it, by adding a comment that the package is approved, removing the blocker on RF_REVIEW (#3) and setting the review request to block the tracker bug RF_ACCEPT (#4).

Ask for creation of a directory for your package in svn.

Once approved the submitter sends a private mail to Dams (anvil@rpmfusion.org)* to request the creation of a directory in svn for this package and the creation of an ACL so that he will be able to write to that dir. If this is your first package then Dams will also create an svn account for you.

* ATM, Dams is the only person with the necessary powers to create the needed ACL.

3.5. Import your package

Once the dir has been created in svn, the package must be imported into svn. RPM Fusion recently has created an import script, but that's alpha, so you might want to do the manual import.

3.5.1. Configure SSH

The svn.rpmfusion.org Subversion sshd listens on a non-default port, 6868. To configure it, add something like this to your ~/.ssh/config:

Host svn.rpmfusion.org
     Port 6868

3.5.2. Import the manual way

Before you can begin the import you need to have a directory structure matching that in svn, or a complete checkout of svn. If you already have this you can skip the steps below:

   mkdir <some-convenient-path>/rpmfusion
   cd <some-convient-path>/rpmfusion
   svn co svn+ssh://<username>@svn.rpmfusion.org/rlo/plague-svn
   svn co svn+ssh://<username>@svn.rpmfusion.org/rlo/common
   mkdir packages

And then now the actual importing:

   cd <some-convenient-path>/rpmfusion/packages
   svn co svn+ssh://<username>@svn.rpmfusion.org/rlo/packages/<package-name>
   cd <package-name>
   svn mkdir devel
   svn copy ../../plague-svn/Makefile-in-package-dir ./Makefile
   svn copy ../../plague-svn/Makefile-in-branch-dir ./devel/Makefile
   <favorite editor> devel/Makefile -> change NAME to <package-name>
   cd devel
   cp <package-name>.spec <package-sources> <package-patches> .
   sha1sum <files-to-be-imported-in-lookaside-cache> > SHA1SUM
   svn add <package-name>.spec <package-patches> SHA1SUM
   cd ..
   svn commit -m "initial devel libmms import" Makefile devel
   svn copy devel F-<current>
   echo FC-<current> > F-<current>/branch; svn add F-<current>/branch
   svn commit -m "initial F-<current> libmms import" F-<current>

See other packages in svn for correct branch names (FC-6, F-7, devel, ...)

3.5.3. Automated import

If you already have a checkout of the common dir you can skip the steps below:

   mkdir <some-convenient-path>/rpmfusion
   cd <some-convient-path>/rpmfusion
   svn co svn+ssh://<username>@svn.rpmfusion.org/rlo/common

Next download the ALPHA svn-import.sh script and save it in the common dir, then do:

   chmod +x svn-import.sh
   ./svn-import.sh <path-to>/<package-name>-<version>-<release>.src.rpm

And sit back and relax while the script (hopefully) does the work for you.

3.6. Tag the imported sources

Now you should tag the just imported sources so that the plague buildsys can find them:

   cd <some-convenient-path>/rpmfusion/packages/<package-name>/devel
   make tag
   cd <some-convenient-path>/rpmfusion/packages/<package-name>/F-<current>
   make tag

If make tag fails on this line:

   test -z "$(LC_ALL=en_US.UTF-8 svn status $(dirname <package-name>.spec))"

Do a "svn status" in the dir. Any files which are printed with a "?" in front of them should be removed (unless they should be in svn in which case you should do a: "svn add <filename>"). If there are files with a letter in front of them, then the dir contains changes not yet committed to svn, commit them and try again.

3.7. Request a build

Add a comment to the review that the import has been done, remove the blocker on RF_ACCEPT (#4) and close the bug as RESOLVED FIXED.

4. Updating an existing package

1. Update your local copy and test it
2. Remember to keep the SHA1SUM file up to date with sha1sums of all files in the look aside cache (or destined to it). Do this even if you don't have access to upload to the look aside cache, it is a prerequisite for updating it.
3. Commit your changes to svn, with a _useful_ changelog message (same command line syntax as cvs, see svn docs)
4. After committing your change run "make tag" to tag your files so that the plague buildsystem can find the correct version to build.
5. The commit message from step 3 is sent to a mailing list which is being monitored by people who can update the look aside cache (if necessary) and give the build command to the plague buildsys.

CategoryContributing