-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #306 from c4dt/update_template
Update template
- Loading branch information
Showing
6 changed files
with
112 additions
and
69 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -37,43 +37,57 @@ in `(brackets)`. | |
| ### Needed | ||
|
|
||
| ```yaml | ||
| (url_path): | ||
| name: (lowercase short name) | ||
| description: > | ||
| (Short description, will be shown under the name) | ||
| contacts: | ||
| - name: (Full Name) | ||
| email: ([email protected]) | ||
| tags: | ||
| - (Add tags, if possible out of the existing ones) | ||
| type: (Application / Library) | ||
| date_added: (YYYY-MM-DD) | ||
| date_updated: (YYYY-MM-DD) | ||
| url_path: | ||
| name: (lowercase short name) | ||
| description: > | ||
| (Short description, will be shown under the name) | ||
| categories: ( "Privacy" | "Blockchain" | "Verification" | "Security" | | ||
| "Learning" | "Other" ) | ||
| applications": ( "Finance" | "Health" | "Gov" | "Infra" | "Info" | "Other" ) | ||
| tags: | ||
| - (Add tags, if possible out of the existing ones) | ||
| date_added: (YYYY-MM-DD) | ||
| ``` | ||
| ### Optional | ||
| ```yaml | ||
| layman_desc: > | ||
| (A 2-3 sentence description for somebody with general knowledge) | ||
| tech_desc: > | ||
| (A more detailed description in 2-3 sentences for somebody knowledgeable in the subject) | ||
| url: (URL for a home page) | ||
| code: | ||
| type: (Lab Github, Personal Gihub, zip files, ...) | ||
| url: (https://...) | ||
| date_last_commit: (YYYY-MM-DD) | ||
| language: (What the majority of the code is written in | ||
| license: (BSD, GPL 3+, MPL 2+, Apache, ...) | ||
| maturity: (1|2|3) | ||
| information: (zero or more of:) | ||
| - type: (Paper | Video | Article | Blog Post | Demo | Web Page | Documentation) | ||
| title: (Short title) | ||
| url: (https:.. - for papers, don't use arxiv, but the conference link) | ||
| notes: (this is optional) | ||
| - label: (what will be shown in front of the note) | ||
| text: (the text of the note) | ||
| url: (the URL for the <a> tag) | ||
| layman_desc: > | ||
| (A 2-3 sentence description for somebody with general knowledge) | ||
| tech_desc: > | ||
| (A more detailed description in 2-3 sentences for somebody knowledgeable in the subject) | ||
| type: ( "Application" | "Library" | "Framework" | "Toolset" | "Simulation" | "Experiments" ) | ||
| notes: (Additional description) | ||
| url: (URL for a home page) | ||
| contacts: | ||
| - name: (Full Name) | ||
| email: ([email protected]) | ||
| code: | ||
| type: (Lab Github, Personal Gihub, zip files, ...) | ||
| url: (https://...) | ||
| date_last_commit: (YYYY-MM-DD) | ||
| doc: (url to documentation) | ||
| lines_of_code: (# of codelines) | ||
| c4dt_contact: (Email of a special contact, defaults to [email protected]) | ||
| language: (What the majority of the code is written in) | ||
| license: (BSD, GPL 3+, MPL 2+, Apache, ...) | ||
| information: (zero or more of:) | ||
| - type: (Paper | Video | Article | Blog Post | Demo | Web Page | Documentation) | ||
| title: (Short title) | ||
| url: (https:.. - for papers, don't use arxiv, but the conference link) | ||
| notes: (this is optional) | ||
| - label: (what will be shown in front of the note) | ||
| text: (the text of the note) | ||
| url: (the URL for the <a> tag) | ||
| maturity: (1|2|3) | ||
| incubator: | ||
| work: (What C4DT did for the project) | ||
| products: | ||
| type: ( Demo | Hands-on | Pilot | App ) | ||
| url: (https://...) | ||
| title: (Description of this product) | ||
| code: (https:// of the code) | ||
| date_updated: (YYYY-MM-DD) | ||
| ``` | ||
| ## Run the application locally | ||
|
|
@@ -135,3 +149,18 @@ Restart Apache: | |
| ``` | ||
| $ sudo /etc/init.d/apache2 restart | ||
| ``` | ||
| # Contributing | ||
| To contribute to this repository, please install the pre-commit hooks: | ||
| ``` | ||
| pre-commit install | ||
| ``` | ||
| This will run the linter before committing. | ||
| If you already committed, you can run it like this: | ||
| ``` | ||
| pre-commit run --all | ||
| ``` | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -52,31 +52,6 @@ | |
| "Info", | ||
| "Other" | ||
| ])), | ||
| sy.Optional("notes"): sy.Str(), | ||
| sy.Optional("url"): sy.Url(), | ||
| sy.Optional("layman_desc"): sy.Str(), | ||
| sy.Optional("tech_desc"): sy.Str(), | ||
| sy.Optional("code"): sy.Map({ | ||
| "type": sy.Str(), | ||
| sy.Optional("url"): sy.Url(), | ||
| sy.Optional("date_last_commit"): sy.Datetime(), | ||
| }), | ||
| sy.Optional("doc"): sy.Url(), | ||
| sy.Optional("lines_of_code"): sy.Str(), | ||
| sy.Optional("contacts"): sy.Seq( | ||
| sy.Map({ | ||
| "name": sy.Str(), | ||
| sy.Optional("email"): sy.Email(), | ||
| sy.Optional("url"): sy.Url(), | ||
| }), | ||
| ), | ||
| sy.Optional( | ||
| "c4dt_contact", | ||
| default={"name": "C4DT team", "email": "[email protected]"} | ||
| ): sy.Map({ | ||
| "name": sy.Str(), | ||
| "email": sy.Email(), | ||
| }), | ||
| "tags": sy.Seq(sy.Enum([ | ||
| "Access Control", "Anonymity", "Attack", | ||
| "Benchmark", "Binary", "Bluetooth", "Byzantine Resilience", | ||
|
|
@@ -96,14 +71,42 @@ | |
| "TensorFlow", "Tor", | ||
| "Zero-Knowledge Proofs" | ||
| ])), | ||
| sy.Optional("language"): sy.Str(), | ||
| "date_added": sy.Datetime(), | ||
|
|
||
| sy.Optional("layman_desc"): sy.Str(), | ||
| sy.Optional("tech_desc"): sy.Str(), | ||
| sy.Optional("type"): sy.CommaSeparated(sy.Enum([ | ||
| "Application", | ||
| "Library", | ||
| "Framework", | ||
| "Toolset", | ||
| "Simulation", | ||
| ])), | ||
| "Experiments", | ||
| ])), | ||
| sy.Optional("notes"): sy.Str(), | ||
| sy.Optional("url"): sy.Url(), | ||
| sy.Optional("contacts"): sy.Seq( | ||
| sy.Map({ | ||
| "name": sy.Str(), | ||
| sy.Optional("email"): sy.Email(), | ||
| sy.Optional("url"): sy.Url(), | ||
| }), | ||
| ), | ||
| sy.Optional("code"): sy.Map({ | ||
| "type": sy.Str(), | ||
| sy.Optional("url"): sy.Url(), | ||
| sy.Optional("date_last_commit"): sy.Datetime(), | ||
| }), | ||
| sy.Optional("doc"): sy.Url(), | ||
| sy.Optional("lines_of_code"): sy.Str(), | ||
| sy.Optional( | ||
| "c4dt_contact", | ||
| default={"name": "C4DT team", "email": "[email protected]"} | ||
| ): sy.Map({ | ||
| "name": sy.Str(), | ||
| "email": sy.Email(), | ||
| }), | ||
| sy.Optional("language"): sy.Str(), | ||
| sy.Optional("license"): sy.CommaSeparated(sy.Enum([ | ||
| "AGPL-3.0", | ||
| "GPL-2.0", "GPL-3.0", | ||
|
|
@@ -135,8 +138,6 @@ | |
| ), | ||
| }), | ||
| ), | ||
| "date_added": sy.Datetime(), | ||
| sy.Optional("date_updated"): sy.Datetime(), | ||
| sy.Optional("maturity"): sy.Int(), | ||
| sy.Optional("incubator"): sy.Map({ | ||
| "work": sy.Str(), | ||
|
|
@@ -148,8 +149,10 @@ | |
| sy.Optional("code"): sy.Str(), | ||
| }), | ||
| ) | ||
| }) | sy.EmptyList(), | ||
| }) | ||
| }), | ||
| sy.Optional("date_updated"): sy.Datetime() | ||
| | sy.EmptyList(), | ||
| }), | ||
| ) | ||
| }) | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters