CONTRIBUTING.rst

   1 ==========
   2 Sponsoring
   3 ==========
   4
   5 Expectations
   6 ============
   7
   8 To accept a new package in the Debian archive, we need the following:
   9
  10 1. Clean copyright file
  11 1. Except with very good reasons, it should generate only one Debian package
  12    please use ``collapse_features = true`` in debcargo.toml to avoid that
  13 1. No lintian warning except ``initial-upload-closes-no-bugs`` (for libraries)
  14 1. autopkgtest should be green (or skipped)
  15 1. New binaries should have an open ITP
  16 1. The maintainer should be on IRC: #debian-rust on OTFC
  17 1. If the crate needs dependencies not available yet in Debian, document them
  18    in the RFS file
  19 1. If you are asking for sponsoring on an existing key crate, please make sure it isn't
  20    breaking a lot of things. If it does, please identify the necessary steps
  21 1. Patience
  22
  23
  24 Ready for upload (Request For Sponsor)
  25 ======================================
  26
  27 If you do not have upload rights, simply ``touch src/$crate/debian/RFS`` in
  28 your crate's directory, commit and push it, and a DD or DM will get around to
  29 it at some point.
  30
  31 Please join the IRC channel #debian-rust on OFTC to be available to answer
  32 to questions. Please monitor the RFS file as the sponsors can use it to
  33 communicate with the maintainer.
  34
  35 If you haven't seen activity for 2 or 3 weeks, feel free to ping sylvestre on the
  36 IRC #debian-rust channel.
  37
  38 If your update breaks semver compatibility, please first check the reverse
  39 dependencies by running::
  40
  41     $ aptitude search '~Dlibrust-$cratename'
  42
  43 and try to verify that they won't be broken by your update, by building them.
  44 If they are broken, then:
  45
  46 1. Document the problem in ``debian/BLOCK``.
  47 2. File an issue upstream to report that they should update to the new library
  48 3. Write a patch if you can get that working, and document it.
  49
  50
  51 Review list
  52 ===========
  53
  54 To list all packages under RFS, run ``dev/list-rfs.sh``.