GithubStar/RSSHub
1
0
Fork 0
mirror of https://github.com/DIYgod/RSSHub.git synced 2026-10-16 21:02:57 +08:00
Code Issues Packages Projects Releases Wiki Activity

chore: update prompts

Browse Source
This commit is contained in:
TonyRL
2026-09-04 03:06:11 +08:00
parent c1c23aba5f
commit d629c66a42
3 changed files with 47 additions and 59 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/prompts/pr_review_rules.md
-1
View File
@@ -47,4 +47,3 @@ Only report **clear and actionable** violations in changed lines/files. Do not r
- Report only violated rules.
- Each bullet should include: file path, problem, and concrete fix.
- Group repeated issues across files into one concise bullet when possible.
- If no rule is clearly violated, do not comment.
.github/workflows/pr-review.yml
+1 -2
View File
@@ -131,7 +131,6 @@ jobs:
1. Use GitHub CLI commands to inspect this PR's metadata and code changes.
2. Review only based on the following rules.
3. Report only clear and actionable violations from changed files.
4. If no clear violations are found, do not comment.
Review rules:
$RULES
@@ -147,7 +146,7 @@ jobs:
- Check existing comments in issue comments for this marker.
- If a marker comment exists, update it with latest findings.
- Otherwise create a new PR comment.
- If there are no findings and marker comment exists, edit marker comment to a short pass status.
- If there are no findings: when a marker comment exists, edit it to the short pass status below; when none exists, do not comment.
gh command reference (PR_NUMBER and GITHUB_REPOSITORY are available as env vars):
- Create a new PR comment:
AGENTS.md
+46 -56
View File
@@ -4,124 +4,114 @@
1. **Example Format**: The `example` field must start with `/` and be a working RSSHub route path (e.g., `/example/route`), not a full URL or source website URL.
2. **Route Name**: Do NOT repeat the namespace name in the route name. The namespace is already defined in `namespace.ts`.
2. **Route Name**: Do not repeat the namespace name in the route name. The namespace is already defined in `namespace.ts`.
3. **Radar Source Format**: Use relative paths without `https://` prefix in `radar[]. source`. Example: `source: ['www.example.com/path']` instead of `source: ['https://www.example.com/path']`.
4. **Radar Target**: The `radar[].target` must match the route path. If the source URL does not contain a path parameter, do not include it in the target.
5. **Namespace URL**: In `namespace.ts`, the `url` field should NOT include the `https://` protocol prefix.
5. **Namespace URL**: In `namespace.ts`, the `url` field should not include the `https://` protocol prefix.
6. **Single Category**: Provide only ONE category in the `categories` array, not multiple.
6. **Single Category**: Provide only one category in the `categories` array, not multiple.
7. **Unnecessary Files**: Do NOT create separate `README.md` or `radar.ts` files. Put descriptions in `Route['description']` and radar rules in `Route['radar']`.
7. **Unnecessary Files**: Do not create separate `README.md` or `radar.ts` files. Put descriptions in `Route['description']` and radar rules in `Route['radar']`.
8. **Legacy Router**: Do NOT add routes to `lib/router.js` - this file is deprecated.
8. **Features Accuracy**: Set `requirePuppeteer: true` only if your route actually uses Puppeteer. Do not mismatch feature flags.
9. **Features Accuracy**: Set `requirePuppeteer: true` only if your route actually uses Puppeteer. Do not mismatch feature flags.
10. **Maintainer GitHub ID**: The `maintainers` field must contain valid GitHub usernames. Verify that the username exists before adding it.
9. **Maintainer GitHub ID**: The `maintainers` field must contain valid GitHub usernames. Verify that the username exists before adding it.
### Code Style
11. **Naming Convention**: Use `camelCase` for variable names in JavaScript/TypeScript. Avoid `snake_case` (e.g., use `videoUrl` instead of `video_url`).
10. **Naming Convention**: Use `camelCase` for variable names in JavaScript/TypeScript. Avoid `snake_case` (e.g., use `videoUrl` instead of `video_url`).
12. **Type Imports**: Use `import type { ... }` for type-only imports instead of `import { ... }`.
11. **Import Sorting**: Keep imports sorted. Run autofix if linter reports import order issues.
13. **Import Sorting**: Keep imports sorted. Run autofix if linter reports import order issues.
12. **Avoid Loading HTML Twice**: Do not call `load()` from cheerio multiple times on the same content. Reuse the initial `$` object.
14. **Unnecessary Template Literals**: Do not use template literals when simple strings suffice (e.g., use `'plain string'` instead of `` `plain string` ``).
13. **Async/Await in Close**: When closing Puppeteer pages/browsers, use `await page.close()` and `await browser.close()` instead of non-awaited calls.
15. **Avoid Loading HTML Twice**: Do not call `load()` from cheerio multiple times on the same content. Reuse the initial `$` object.
14. **No Explicit Null**: No need to explicitly set a property to `null` if it does not exist - just omit it.
16. **Async/Await in Close**: When closing Puppeteer pages/browsers, use `await page.close()` and `await browser.close()` instead of non-awaited calls.
15. **Valid Item Properties**: Only use properties defined in [lib/types.ts](https://github.com/DIYgod/RSSHub/blob/master/lib/types.ts). Custom properties like `avatar`, `bio` will be ignored by RSSHub.
17. **No Explicit Null**: No need to explicitly set a property to `null` if it does not exist - just omit it.
18. **Valid Item Properties**: Only use properties defined in [lib/types. ts](https://github.com/DIYgod/RSSHub/blob/master/lib/types.ts). Custom properties like `avatar`, `bio` will be ignored by RSSHub.
19. **String Methods**: Use `startsWith()` instead of `includes()` when checking if a string begins with a specific prefix.
20. **Simplify Code**: Combine multiple conditional assignments into single expressions using `||` or `??` operators when appropriate.
16. **String Methods**: Use `startsWith()` instead of `includes()` when checking if a string begins with a specific prefix.
### Data Handling
21. **Use Cache**: Always [cache](https://docs.rsshub.app/joinus/advanced/use-cache) the returned results when fetching article details in a loop using `cache.tryGet()`.
17. **Use Cache**: Always [cache](https://docs.rsshub.app/joinus/advanced/use-cache) the returned results when fetching article details in a loop using `cache.tryGet()`.
22. **Description Content**: The `description` field should contain ONLY the main article content. Do NOT include `title`, `author`, `pubDate`, or tags in `description` - they have their own dedicated fields.
18. **Description Content**: The `description` field should contain ONLY the main article content. Do not include `title`, `author`, `pubDate`, or tags in `description` - they have their own dedicated fields.
23. **Category Field**: Extract tags/categories from articles and place them in the `category` field, not in `description`.
19. **Category Field**: Extract tags/categories from articles and place them in the `category` field, not in `description`.
24. **pubDate Field**: Always include `pubDate` when the source provides date/time information. Use the `parseDate` utility function.
20. **pubDate Field**: Always include `pubDate` when the source provides date/time information. Use the `parseDate` utility function.
25. **No Fake Dates**: Do NOT use `new Date()` as a fallback for `pubDate`. If no date is available, leave it undefined. See [No Date documentation](https://docs.rsshub.app/joinus/advanced/pub-date#no-date).
21. **No Fake Dates**: Do not use `new Date()` as a fallback for `pubDate`. If no date is available, leave it undefined. See [No Date documentation](https://docs.rsshub.app/joinus/advanced/pub-date#no-date).
26. **No Title Trimming**: Do not manually trim or truncate titles. RSSHub core handles title processing automatically.
22. **No Title Trimming**: Do not manually trim or truncate titles. RSSHub core handles title processing automatically.
27. **Unique Links**: Ensure each item's `link` is unique as it will be used as `guid`. Avoid fallback URLs that could cause duplicate `guid` values.
23. **Unique Links**: Ensure each item's `link` is unique as it will be used as `guid`. Avoid fallback URLs that could cause duplicate `guid` values.
28. **Human-Readable Links**: The feed `link` field should point to a human-readable webpage URL, NOT an API endpoint URL.
24. **Human-Readable Links**: The feed `link` field should point to a human-readable webpage URL, not an API endpoint URL.
### API and Data Fetching
29. **Prefer APIs Over Scraping**: When the target website has an API (often found by scrolling pages or checking network requests), use the API endpoint instead of HTML scraping.
25. **Prefer APIs Over Scraping**: When the target website has an API (often found by scrolling pages or checking network requests), use the API endpoint instead of HTML scraping.
30. **JSON Parsing**: When using `ofetch`, `JSON.parse` is automatically applied. Do not manually decode JSON escape sequences like `\u003C`.
26. **JSON Parsing**: When using `ofetch`, `JSON.parse` is automatically applied. Do not manually decode JSON escape sequences like `\u003C`.
31. **No Page Turning**: RSS feeds should only request the first page of content. Do not implement pagination parameters for users.
27. **No Page Turning**: RSS feeds should only request the first page of content. Do not implement pagination parameters for users.
32. **Use Common Parameters**: Use RSSHub's built-in common parameters like [`limit`](https://docs.rsshub.app/guide/parameters#limit-entries) instead of implementing custom query parameters for limiting entries.
28. **Use Common Parameters**: Use RSSHub's built-in common parameters like [`limit`](https://docs.rsshub.app/guide/parameters#limit-entries) instead of implementing custom query parameters for limiting entries.
33. **No Custom Query Parameters**: Avoid using querystring parameters for route configuration. Use path parameters (`:param`) instead.
29. **No Custom Query Parameters**: Avoid using querystring parameters for route configuration. Use path parameters (`:param`) instead.
34. **No Custom Filtering**: Do not implement custom tag/category filtering in routes. Users can apply filtering using [common parameters](https://docs.rsshub.app/guide/parameters).
30. **No Custom Filtering**: Do not implement custom tag/category filtering in routes. Users can apply filtering using [common parameters](https://docs.rsshub.app/guide/parameters).
35. **Avoid Dynamic Hashes**: If an API requires a hash that changes across builds, extract it dynamically from the webpage rather than hardcoding it.
36. **User-Agent**: Use RSSHub's built-in [User-Agent](https://github.com/DIYgod/RSSHub/blob/master/lib/config.ts#L494) (`config.trueUA`) when making requests that need realistic browser headers.
31. **Avoid Dynamic Hashes**: If an API requires a hash that changes across builds, extract it dynamically from the webpage rather than hardcoding it.
### Media and Enclosures
37. **Valid MIME Types**: The `enclosure_type` must be a valid MIME type as defined in RFC specifications. For example, `video/youtube` is NOT valid - use actual video file URLs with proper types like `video/mp4`.
32. **Valid MIME Types**: The `enclosure_type` must be a valid MIME type as defined in RFC specifications. For example, `video/youtube` is not valid - use actual video file URLs with proper types like `video/mp4`.
38. **Direct Media URLs**: `enclosure_url` must point directly to downloadable media files (e.g., `.mp4`, `.mp3`), not to web pages containing media.
33. **Direct Media URLs**: `enclosure_url` must point directly to downloadable media files (e.g., `.mp4`, `.mp3`), not to web pages containing media.
39. **Video Poster**: Use the HTML5 `<video>` element's `poster` attribute for video thumbnails instead of adding separate `<img>` elements.
34. **Video Poster**: Use the HTML5 `<video>` element's `poster` attribute for video thumbnails instead of adding separate `<img>` elements.
40. **No Referrer Policy in Routes**: Do not add `referrerpolicy` attributes to images/videos - RSSHub middleware handles this automatically.
35. **No Referrer Policy in Routes**: Do not add `referrerpolicy` attributes to images/videos - RSSHub middleware handles this automatically.
### Puppeteer Usage
41. **Limit Request Types**: Do not allow every type of request through Puppeteer. Explicitly provide a list of allowed request types (e.g., `document`) to avoid wasting resources on images, scripts, etc.
36. **Limit Request Types**: Do not allow every type of request through Puppeteer. Explicitly provide a list of allowed request types (e.g., `document`) to avoid wasting resources on images, scripts, etc.
42. **Use Selectors, Not Delays**: Do not use fixed `setTimeout` delays. Use `page.waitForSelector()` instead to wait for specific elements.
37. **Use Selectors, Not Delays**: Do not use fixed `setTimeout` delays. Use `page.waitForSelector()` instead to wait for specific elements.
43. **Avoid Multiple Sessions**: Do not call Puppeteer inside `Promise.all()` loops - this creates multiple browser sessions and dramatically increases resource usage.
38. **Avoid Multiple Sessions**: Do not call Puppeteer inside `Promise.all()` loops - this creates multiple browser sessions and dramatically increases resource usage.
44. **Do Not Bypass Empty Checks**: Do not return empty arrays with custom messages to bypass RSSHub's [internal checks](https://github.com/DIYgod/RSSHub/blob/master/lib/middleware/parameter. ts#L72) for empty items. This makes it hard for users and maintainers to know if a feed is broken.
39. **Do Not Bypass Empty Checks**: Do not return empty arrays with custom messages to bypass RSSHub's [internal checks](https://github.com/DIYgod/RSSHub/blob/master/lib/middleware/parameter.ts) for empty items. This makes it hard for users and maintainers to know if a feed is broken.
### Default Values and Examples
45. **Preserve Default Values**: Do not change documented default values for existing route parameters unless the current default is broken.
40. **Preserve Default Values**: Do not change documented default values for existing route parameters unless the current default is broken.
46. **Preserve Working Examples**: Do not modify existing route examples unless they no longer work.
41. **Preserve Working Examples**: Do not modify existing route examples unless they no longer work.
47. **Route Parameters**: The `parameters` object keys must match the actual path parameters defined in the route path. Do not add non-existent parameters.
42. **Route Parameters**: The `parameters` object keys must match the actual path parameters defined in the route path. Do not add non-existent parameters.
### Error Handling
48. **Error Messages**: Use clear, actionable error messages that help users understand what went wrong.
43. **Error Messages**: Use clear, actionable error messages that help users understand what went wrong.
49. **Resolve All Review Comments**: Before requesting re-review, ensure ALL previous review comments are addressed, not just some of them.
44. **Resolve All Review Comments**: Before requesting re-review, ensure ALL previous review comments are addressed, not just some of them.
### Code Organization
50. **Move Functions Up**: Move function definitions to the highest possible scope. Avoid defining functions inside loops or callbacks when they can be defined at module level.
45. **Move Functions Up**: Move function definitions to the highest possible scope. Avoid defining functions inside loops or callbacks when they can be defined at module level.
51. **No Await in Loops**: Avoid using `await` inside loops when possible. Use `Promise.all()` with proper concurrency control instead.
46. **No Await in Loops**: Avoid using `await` inside loops when possible. Use `Promise.all()` with proper concurrency control instead.
52. **Check URL Validity**: Before using URLs from config files or namespaces, verify they don't return 404 errors.
47. **Check URL Validity**: Before using URLs from config files or namespaces, verify they don't return 404 errors.
53. **Comments Language**: Write code comments in English for consistency and accessibility.
48. **Comments Language**: Write code comments in English for consistency and accessibility.
54. **Parentheses in Arrow Functions**: Always use parentheses around arrow function parameters, even for single parameters.
49. **Parentheses in Arrow Functions**: Always use parentheses around arrow function parameters, even for single parameters.