logos-messaging/packages
1
0
Fork 0
mirror of https://github.com/logos-messaging/packages.git synced 2026-01-07 16:43:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add more requirements to the package list

Browse Source
This commit is contained in:
Federico Ceratto 2016-04-06 21:53:51 +01:00
parent 348a6fa054
commit 716e56e280
1 changed files with 13 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -4,6 +4,8 @@ This is a central listing of all packages for
[Nimble](https://github.com/nim-lang/nimble), a package manager for the [Nimble](https://github.com/nim-lang/nimble), a package manager for the
[Nim programming language](http://nim-lang.org). [Nim programming language](http://nim-lang.org).
NOTE: The packages listed here are not peer-reviewed or otherwise screened. We try to keep the list up-to-date but we cannot guarantee quality or maturity of the packages.
## Adding your own package ## Adding your own package
To add your own package, fork this repository, edit To add your own package, fork this repository, edit
[packages.json](packages.json) and make a pull request. [packages.json](packages.json) and make a pull request.
@ -20,10 +22,16 @@ optional):
* tags - A list of tags describing this package. * tags - A list of tags describing this package.
* description - A description of this package. * description - A description of this package.
* license - The license of the source code in the package. * license - The license of the source code in the package.
* web - An optional url for humans to read additional information about * web - An optional URL for humans to read additional information about
the package. the package.
* doc - An optional URL for humans to read the package HTML documentation
Your packages may be removed if the url stops working. It goes without saying ### Requirements
that your pull request will not be accepted unless you fill out all of the
above required fields correctly, the package that ``url`` points to must also While we really appreciate your contribution, please ensure that you package matches the following requirements: other developers rely on your package. Non-compliant packages might be removed with no warning.
contain a .nimble file, or else it will be rejected.
* The URL should work, a .nimble file should be present and the package should be installable
* 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)
* If abandoning a package, please tag it as "abandoned".