From b89c56b96ea3f183c6b1f35176ee740f7bd96506 Mon Sep 17 00:00:00 2001 From: Wolfgang Bumiller Date: Tue, 5 Oct 2021 10:23:58 +0200 Subject: [PATCH] start checklist for adding crates in README.rst Signed-off-by: Wolfgang Bumiller --- README.rst | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.rst b/README.rst index 12deebba..46745225 100644 --- a/README.rst +++ b/README.rst @@ -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 "]`` + - Add ``license = "AGPL-3"`` + - Add ``exclude = [ "debian" ]`` + - Add a meaningful ``description`` + - Copy ``debian/copyright`` and ``debian/debcargo.toml`` from another subcrate.