[Initiatives.wiki] Create App Metadata



commit 29ba6e8188da8824312df8ba82932d1c82a94497
Author: Tobias Bernard <tbernard gnome org>
Date:   Mon Jun 8 10:41:36 2020 +0000

    Create App Metadata

 App-Metadata.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 55 insertions(+)
---
diff --git a/App-Metadata.md b/App-Metadata.md
new file mode 100644
index 0000000..d17f822
--- /dev/null
+++ b/App-Metadata.md
@@ -0,0 +1,55 @@
+Areas covered by the initiative:
+
+Appstream:
+  * Summary
+  * Description
+  * Developer name
+  * Various links
+  * Release notes
+  * Screenshots
+
+Repository Metadata:
+  * README
+  * Repository icon
+
+## Summary
+
+The summary should answer this question at a glance: **"What superpower does this app give me?"**. It 
doesn't need to comprehensively describe everything the app does, as long as it highlights one important 
aspect and makes it clear why it's valuable.
+
+General guidance:
+- Keep it short (35 characters or less)
+- Peak people's curiosity
+- Use imperative if possible (e.g. "Browse the web" instead of "A web browser")
+- Use sentence case
+
+Avoid:
+- Technical details (e.g. the toolkit or programming language)
+- Structures like "GUI for X" or "Client for Y"
+- Mentioning the target environment (e.g. "X for GNOME")
+- Repeating the app's name
+- Overly generic adjectives like "simple", "easy", "modern", "powerful", etc.
+- Articles (e.g. "A ..." or "An ...")
+- Punctuation (e.g. a period at the end)
+- Title case (e.g. "A Modern Matrix Client")
+
+Good examples:
+- Maps: "Find places around the world"
+- Shortwave: "Listen to internet radio"
+- Slack: "Chat with your team"
+
+Bad Examples:
+- Tau: "GTK frontend for the xi text editor"
+- Contacts: "A contacts manager for GNOME"
+- Devhelp: "A developer tool for browsing and searching API documentation"
+
+[Appstream documentation](https://www.freedesktop.org/software/appstream/docs/chap-Metadata.html#tag-summary)
+
+## Description
+
+## Developer name
+
+## Links
+
+## Release Notes
+
+## Screenshots
\ No newline at end of file


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]