mirror of
https://github.com/mustbeperfect/definitive-opensource.git
synced 2026-04-17 15:43:26 +02:00
Updated contributing documents formatting
This commit is contained in:
2
.github/CONTRIBUTING.md
vendored
2
.github/CONTRIBUTING.md
vendored
@@ -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
|
||||
|
||||
5
.github/GUIDELINES.md
vendored
5
.github/GUIDELINES.md
vendored
@@ -22,8 +22,7 @@ To avoid the clutter trap that many other lists succumb to as they scale, only t
|
||||
- ```📔``` Projects with over 5000 stars are preferred.
|
||||
|
||||
### 2. A Foundation
|
||||
- ```🛑``` A minimum contributor count of 5.
|
||||
- ```📔``` Quality is more important than quantity here. A small team can pass if they are solid and dedicated.
|
||||
- ```⚠️``` A contributor count of 5. Quality is more important than quantity here. A small team can pass if they are solid and dedicated.
|
||||
- ```⚠️``` The project should have stable roots, as in no internal conflicts or major disagreements that impact development.
|
||||
|
||||
### 3. Activity
|
||||
@@ -46,7 +45,7 @@ The project's license should be an [OSI Approved License](https://opensource.org
|
||||
- **Description:** A free, source-available and fair-code licensed mac app cleaner
|
||||
- **Stars:** 4.2k
|
||||
- **Contributors:** 7
|
||||
- **Explanation:** On the surface PearCleaner woudn't fit with a relatively small amount of stars and just seven contributors. But research brings about the following conclusion: PearCleaner is one of two major app cleaners for MacOS - the other being the proprietary AppCleaner. Despite just 7 contributors, they have been continuously pushing updates on a ~two week interval. They have a solid roadmap for future updates and been delivering on those promises.
|
||||
- **Explanation:** On the surface PearCleaner woudn't fit with a relatively small amount of stars and just seven contributors. But research brings about the following conclusion: PearCleaner is one of two major app cleaners for MacOS - the other being the proprietary AppCleaner. Despite just 7 contributors, they have been continuously pushing updates on a ~two week interval. They have a solid roadmap for future updates and have been delivering on those promises.
|
||||
- ```Result: ✅```
|
||||
|
||||
### 2. Marktext
|
||||
|
||||
21
.github/SECURITY.md
vendored
21
.github/SECURITY.md
vendored
@@ -2,26 +2,29 @@
|
||||
|
||||
The inherent nature of this project has no security vulnerabilities, but this isn't the case for the hundreds of projects we feature here. Raise an issue if a project had/is having a security incident, and it will be labeled with the appropriate tag.
|
||||
|
||||
|
||||
|
||||
`🟡` `🟠` `🔴` `⭕` - Security incident **(Minor, Moderate, Major, Critical)**
|
||||
|
||||
`🟡` - Low impact issues that do not significantly compromise security
|
||||
```
|
||||
🟡 - Low impact issues that do not significantly compromise security
|
||||
* Weak encryption
|
||||
* Oudated dependencies with low-severity CVEs.
|
||||
* Minor security concerns raised but not actively exploited
|
||||
```
|
||||
|
||||
|
||||
`🟠` - Issues that pose a potential risk but not actively exploited
|
||||
```
|
||||
🟠 - Issues that pose a potential risk but not actively exploited
|
||||
* Outdated dependencies with moderate-severity CVEs
|
||||
```
|
||||
|
||||
|
||||
`🔴` - High impact issues that are being actively exploited, resulting in a significant security breach
|
||||
```
|
||||
🔴 - High impact issues that are being actively exploited, resulting in a significant security breach
|
||||
* Outdated dependencies with major security risks
|
||||
* Leaked API keys
|
||||
```
|
||||
|
||||
|
||||
`⭕` - Catastrophic issues with widespread impact
|
||||
```
|
||||
⭕ - Catastrophic issues with widespread impact
|
||||
* Zero-day exploits
|
||||
* Full system compromise
|
||||
* Mass data breach
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user