Expanded on tag and description guidelines

This commit is contained in:
Lucas
2025-02-27 15:31:40 -08:00
committed by GitHub
parent 1864445025
commit 1484524f8d

View File

@@ -18,10 +18,10 @@ The scale of what this project is attempting to accomplish is one that can only
## Conventions
To establish uniformity accross the project, please adhere to these conventions.
- Use the project's official name, not the repository name. Repository names often use lowercase and place dashes in place of spaces. Fallback to **Title Casing** if capitalization is not clear.
- Platform tags are listed in the following order: ```Desktop OS```, ```Mobile```, ```CLI```, ```SelfHost```, ```Web```, ```Plugin```
- Platform tags are listed in the following order: ```Desktop OS (Order: Windows, MacOS, Linux)```, ```Mobile (Order: Android, IOS)```, ```CLI```, ```SelfHost```, ```Web```, ```Plugin```
- One space to the ```| left and right |``` for row elements
- For projects with multiple repositories (EX: one for IOS, Windows, etc) link the organization. For API star retrieval use their most popular repository.
- The description should be the repo description. If there are multiple repositories, no description, or an inadequate one, fall back to organization or the projects website. **Do not write your own description.**
- The description should be the repository description. If there are multiple repositories, no description, or an inadequate one, fall back to the organization or their official website, or their repo's README. **Do not write your own description and only use text from official sources of the project.**
- We use [Github Flavored Markdown (GFM)](https://docs.github.com/en/get-started/writing-on-github)
## Guidelines