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