Skip to content

Conversation

@alkaline-0
Copy link
Contributor

Tell us what you do here

  • update internal AI rules and documentation under ai/.rules/
  • Updates AI rules to only target Python files and switches rules to opt‑in by setting alwaysApply to false.
  • Adds/extends descriptions and guidance across the rule docs to improve clarity and consistency.

Related Issues

Closes #668

Additional Context

  1. Changes limited to documentation/rules in ai/.rules/:
  2. Scope rules to Python files only
  3. Set alwaysApply: false to prevent unintended automatic application
  4. Clarify and refine guidance in:
  5. build-rest-api.md
  6. rest_api_extract_parameters.md
  7. rest_api_pagination.md
  8. dlt.md

@alkaline-0 alkaline-0 self-assigned this Nov 24, 2025
@alkaline-0 alkaline-0 marked this pull request as draft November 24, 2025 15:45
@alkaline-0 alkaline-0 force-pushed the feat/668-update-rules-with-description branch from 7a7d754 to d36c159 Compare November 24, 2025 16:49
@alkaline-0 alkaline-0 marked this pull request as ready for review November 24, 2025 17:02
@alkaline-0 alkaline-0 requested a review from zilto November 24, 2025 17:02
Copy link
Collaborator

@zilto zilto left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes look good. Please investigate the comment I left and manually try the new rules in Continue / Cursor / Copilot (if you have access).

You should see whether or not:

  • the rules are loaded on all conversation turns
    • try an irrelevant query "what are the available files in this repo"
  • the rules are selectively loaded when asking about dlt, REST API, etc.
    • try a relevant query "how can I load data from the GitHub REST API" or "how can I load data with dlt?"

@alkaline-0 alkaline-0 force-pushed the feat/668-update-rules-with-description branch 2 times, most recently from 57376ef to 735fa7f Compare November 24, 2025 17:32
* Updated Makefile to modify the alwaysApply setting for rules and ensure proper rendering of API documentation.
* Added comprehensive guidelines for writing sources with cursor-based pagination in AGENT.md files for amp, codex, and claude.
* Included prerequisites, authentication methods, and pagination strategies to improve clarity and usability for developers.
@alkaline-0 alkaline-0 force-pushed the feat/668-update-rules-with-description branch from 6ac6ef4 to be874e9 Compare November 25, 2025 16:04
@alkaline-0 alkaline-0 requested a review from zilto November 25, 2025 16:05
Copy link
Collaborator

@zilto zilto left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me!

@zilto zilto merged commit 5aac1bf into master Nov 25, 2025
14 checks passed
@zilto zilto deleted the feat/668-update-rules-with-description branch November 25, 2025 16:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat(ai): update rules with description field

3 participants