You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The CLI evaluates repositories based on these criteria:
126
+
The CLI evaluates repositories based on these criteria. When community health files are missing from a repository, the tool automatically checks the organization's `.github` repository for default community health files:
-**Repository Name** (5 points): Descriptive and relevant name
144
144
-**Active Repository** (5 points): Not archived
145
145
146
+
### Organization-Level Community Health Files
147
+
148
+
RepoReady automatically checks for community health files in the organization's `.github` repository when they're missing from the individual repository. This follows [GitHub's community health file standards](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file) where organizations can provide default files for all their repositories.
149
+
150
+
Files checked at the organization level include:
151
+
-`CODE_OF_CONDUCT.md`
152
+
-`CONTRIBUTING.md`
153
+
-`LICENSE` (and variants)
154
+
- Issue templates in `.github/ISSUE_TEMPLATE/`
155
+
-`PULL_REQUEST_TEMPLATE.md`
156
+
146
157
## Scoring & Ratings
147
158
148
159
-**Excellent** (90-100%): Ready for contributors with outstanding setup
Copy file name to clipboardExpand all lines: src/evaluator/criteria.ts
+5-5Lines changed: 5 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -129,19 +129,19 @@ export function generateRecommendations(results: Array<{ criteria: string; passe
129
129
recommendations.push('Create a comprehensive README.md with project description, installation, and usage instructions');
130
130
break;
131
131
case'Contributing Guidelines':
132
-
recommendations.push('Add a CONTRIBUTING.md file explaining how others can contribute to your project');
132
+
recommendations.push('Add a CONTRIBUTING.md file explaining how others can contribute to your project (can be added to the repository or organization\'s .github repository)');
133
133
break;
134
134
case'Code of Conduct':
135
-
recommendations.push('Add a CODE_OF_CONDUCT.md file to create a welcoming environment for contributors');
135
+
recommendations.push('Add a CODE_OF_CONDUCT.md file to create a welcoming environment for contributors (can be added to the repository or organization\'s .github repository)');
136
136
break;
137
137
case'Open Source License':
138
-
recommendations.push('Add an open source license (MIT, Apache 2.0, GPL, etc.) to make your project truly open source');
138
+
recommendations.push('Add an open source license (MIT, Apache 2.0, GPL, etc.) to make your project truly open source (can be added to the repository or organization\'s .github repository)');
139
139
break;
140
140
case'Issue Templates':
141
-
recommendations.push('Create issue templates in .github/ISSUE_TEMPLATE/ to help contributors report bugs and request features');
141
+
recommendations.push('Create issue templates in .github/ISSUE_TEMPLATE/ to help contributors report bugs and request features (can be added to the repository or organization\'s .github repository)');
142
142
break;
143
143
case'Pull Request Template':
144
-
recommendations.push('Add a pull request template to standardize contribution submissions');
144
+
recommendations.push('Add a pull request template to standardize contribution submissions (can be added to the repository or organization\'s .github repository)');
145
145
break;
146
146
case'Good First Issues':
147
147
recommendations.push('Create and label some issues as "good first issue" to welcome new contributors');
0 commit comments