proxmox-mirrors/proxmox
1
0
Fork 1
mirror of https://git.proxmox.com/git/proxmox synced 2025-08-13 22:00:01 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

start checklist for adding crates in README.rst

Browse Source 
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
This commit is contained in:
Wolfgang Bumiller 2021-10-05 10:23:58 +02:00
parent f189895cef
commit b89c56b96e
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.rst
View File

@ -20,3 +20,19 @@ Steps for Releases
required, then bump their version as well if not already done.
- Update debian/changelog files in all the crates updated above.
- Build packages with `make deb`.
Adding Crates
=============
1) At the top level:
- Generate the crate: ``cargo new --lib the-name``
- Sort the crate into ``Cargo.toml``'s ``workspace.members``
- Sort the crate into the ``Makefile``'s ``CRATES`` list.
2) In the new crate's ``Cargo.toml``:
- Replace the ``author`` line with
``authors = ["Proxmox Support Team <support@proxmox.com>"]``
- Add ``license = "AGPL-3"``
- Add ``exclude = [ "debian" ]``
- Add a meaningful ``description``
- Copy ``debian/copyright`` and ``debian/debcargo.toml`` from another subcrate.