From b873a66d502e7a7409a4af897b861ea3bb026bd8 Mon Sep 17 00:00:00 2001 From: Federico Ceratto Date: Fri, 15 Jun 2018 18:21:47 +0100 Subject: [PATCH] Add suggestions around packages quality --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index d2fc9ff..a32bdea 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,12 @@ While we really appreciate your contribution, please follow the requirements: ot * The package should build correctly with the latest Nim release * The package should not contain files without a license or in breach of 3rd parties licensing * Non-mature packages should be flagged as such, especially if they perform security-critical tasks (e.g. encryption) +* Tiny libraries should be avoided where possible +* Avoid having many dependencies. Use "when defined(...)" to enable optional features. * If abandoning a package, please tag it as "abandoned" +* The package name should be unique and specific. Avoid overly generic names e.g. "math", "http" +* Provide a contact email address. +* Optionally try to support older Nim releases (6 months to 1 year) * Optionally GPG-sign your releases * Optionally follow [SemVer](http://semver.org)