starred/definitive-opensource
1
0
Fork 0
mirror of https://github.com/mustbeperfect/definitive-opensource.git synced 2026-04-18 00:54:03 +02:00
Code Issues Packages Projects Releases Wiki Activity

Updated contributing documents formatting

Browse Source
This commit is contained in:
Lucas
2025-03-30 11:07:43 -07:00
parent dd2fbc207f
commit f800ad462d
4 changed files with 15 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.github/CONTRIBUTING.md vendored
View File

@@ -20,7 +20,7 @@ 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 (Order: Windows, MacOS, Linux)```, ```Mobile (Order: Android, IOS)```, ```CLI```, ```SelfHost```, ```Web```, ```Plugin```
- For projects with multiple repositories (EX: one for IOS, Windows, etc) link the repository with the most stars.
- The description should be the repository description. If there are multiple repositories, no description, or an inadequate one, fall back to the organization, their official website, or the repo's README. **Do not write your own description, only use text from official sources of the project, and do not modify (EX: shorten) their description.** The ONLY change you can make is replacing ```|``` with ```-``` to prevent interference with GFM tables. If you not using the GitHub description, put the ```custom-description``` flag in the flags array so our description updator script does not override it.
- The description should be the repository description. If there are multiple repositories, no description, or an inadequate one, fall back to the organization, their official website, or the repo's README. **Do not write your own description, only use text from official sources of the project, and do not modify (EX: shorten) their description.** The ONLY change you can make is replacing ```|``` with ```-``` to prevent interference with GFM tables. If you are not using the GitHub repo description, put the ```custom-description``` flag in the flags array so our description updator script does not override it.
- For tags, do not use the emoji. Go to [tags.json](source/data/tags.json) and find the id for the tag. Our script will generate it's corresponding emoji when it builds the README.
## Guidelines