aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFederico Ceratto <federico.ceratto@gmail.com>2018-06-15 18:21:47 +0100
committerGitHub <noreply@github.com>2018-06-15 18:21:47 +0100
commitb873a66d502e7a7409a4af897b861ea3bb026bd8 (patch)
treeb07896f67f1e359df1c6ebea28347dbaaab38f6f
parent4853bb3ecbf47d5a109e098481285806eab1c138 (diff)
downloadpackages-b873a66d502e7a7409a4af897b861ea3bb026bd8.tar.gz
packages-b873a66d502e7a7409a4af897b861ea3bb026bd8.zip
Add suggestions around packages quality
-rw-r--r--README.md5
1 files changed, 5 insertions, 0 deletions
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)