logos-messaging/packages
1
0
Fork 0
mirror of https://github.com/logos-messaging/packages.git synced 2026-01-03 22:53:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add suggestions around packages quality

Browse Source
This commit is contained in:
Federico Ceratto 2018-06-15 18:21:47 +01:00 committed by GitHub
parent 4853bb3ecb
commit b873a66d50
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -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 build correctly with the latest Nim release
* The package should not contain files without a license or in breach of 3rd parties licensing * 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) * 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" * 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 GPG-sign your releases
* Optionally follow [SemVer](http://semver.org) * Optionally follow [SemVer](http://semver.org)