Skip to content

Commit 8b105d3

Browse files
committed
Message file copied, contributing.md udpated
1 parent 5b8be22 commit 8b105d3

File tree

12 files changed

+55
-19
lines changed

12 files changed

+55
-19
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -100,9 +100,19 @@ your source will be distributed to other users once it is accepted into our repo
100100

101101
## Walkthrough: Modify or add rules files for LLM-enabled IDEs
102102
In this section, you will learn how to contribute rules files.
103-
1. Follow the [coding prerequisites](#coding-prerequisites) to setup the repository
104-
2. On your branch, add or modify rules files under the `/ai` directory
105-
3. Verify that the rules are properly formatted and work with the target IDE.
103+
104+
### 1. How the `ai/` directory works
105+
106+
1. The `.rules` folder is the master folder from which the files are rendered and copied into the respective IDE folders with the appropriate structure and format.
107+
2. Rendering and copying of the files are handled by the `make transpile-rules` command.
108+
3. The make transpile-rules command relies on Continue's [rules CLI](https://github.com/continuedev/rules).
109+
110+
### 1. How to modify or add rules
111+
112+
1. Follow the [coding prerequisites](#coding-prerequisites) to setup the repository.
113+
2. On your branch, add or modify rules files under the `/ai/.rules/` directory.
114+
3. Verify that the rules are properly formatted.
115+
4. Run `make transpile-rules` to update the respective IDE folders.
106116
4. Proceed to the pull request section to [create a pull request to the main repo](#making-a-pull-request-to-the-main-repo-from-fork). Please explain for what use cases these rules are useful and share what IDE version you're using.
107117

108118
## Coding Prerequisites

Makefile

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -34,15 +34,15 @@ format-lint: format lint
3434

3535
transpile-rules:
3636
cd ai && \
37-
uv run rules render claude && mkdir -p claude && mv CLAUDE.md claude/ && \
38-
uv run rules render amp && mkdir -p amp && mv AGENT.md amp/ && \
39-
uv run rules render codex && mkdir -p codex && mv AGENT.md codex/ && \
40-
uv run rules render cody && mkdir -p cody && cp -r .sourcegraph cody/ && rm -rf .sourcegraph && \
41-
uv run rules render cline && mkdir -p cline && cp -r .clinerules cline/ && rm -rf .clinerules && \
42-
uv run rules render cursor && mkdir -p cursor && cp -r .cursor cursor/ && rm -rf .cursor && \
43-
uv run rules render continue && mkdir -p continue && cp -r .continue continue/ && rm -rf .continue && \
44-
uv run rules render windsurf && mkdir -p windsurf && cp -r .windsurf windsurf/ && rm -rf .windsurf && \
45-
uv run rules render copilot && mkdir -p copilot && cp -r .github copilot/ && rm -rf .github
37+
uv run rules render claude && mkdir -p claude && mv CLAUDE.md claude/ && cp .rules/.message claude/ && \
38+
uv run rules render amp && mkdir -p amp && mv AGENT.md amp/ && cp .rules/.message amp/ && \
39+
uv run rules render codex && mkdir -p codex && mv AGENT.md codex/ && cp .rules/.message codex/ && \
40+
uv run rules render cody && mkdir -p cody && cp -r .sourcegraph cody/ && rm -rf .sourcegraph && cp .rules/.message cody/ && \
41+
uv run rules render cline && mkdir -p cline && cp -r .clinerules cline/ && rm -rf .clinerules && cp .rules/.message cline/ && \
42+
uv run rules render cursor && mkdir -p cursor && cp -r .cursor cursor/ && rm -rf .cursor && cp .rules/.message cursor/ && \
43+
uv run rules render continue && mkdir -p continue && cp -r .continue continue/ && rm -rf .continue && cp .rules/.message continue/ && \
44+
uv run rules render windsurf && mkdir -p windsurf && cp -r .windsurf windsurf/ && rm -rf .windsurf && cp .rules/.message windsurf/ && \
45+
uv run rules render copilot && mkdir -p copilot && cp -r .github copilot/ && rm -rf .github && cp .rules/.message copilot/ \
4646

4747
test:
4848
uv run pytest tests

ai/README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
1-
The `/ai` directory includes for popular LLM-enabled IDEs (Cursor, Continue, Cline, Claude, etc.).
1+
The `/ai` directory includes rules for popular LLM-enabled Agents and IDEs (Amp, Claude, Cline, Codex, Cody, Continue, Copilot, Cursor, Windsurf).
22
Add them to your project using the `dlt ai setup $IDE` command ([reference](https://dlthub.com/docs/reference/command-line-interface#dlt-ai-setup)).
3-
The way it works is very simple:
43

5-
1. Each folder here corresponds to a particular IDE.
6-
2. `setup` subcommand looks for a folder named `$IDE` and copies all files from it to current `dlt` project.
7-
3. `.message` file is displayed, not copied.
4+
The way it works is very simple:
85

9-
We are pretty sure that command line interface will soon change to support many set of rules per editor focused on specific tasks.
6+
1. Each folder here corresponds to a particular IDE or AI agent.
7+
2. The `setup` subcommand looks for a folder named `$IDE` and copies all files from it to current `dlt` project.
8+
3. The `.message` file is displayed, not copied.
109

11-
If you want to share useful rules, follow the instructions in [CONTRIBUTING.md](../CONTRIBUTING.md#walkthrough-modify-or-add-rules-files-for-llm-enabled-ides).
10+
If you want to share useful rules or make changes to the existing ones, follow the instructions in [CONTRIBUTING.md](../CONTRIBUTING.md#walkthrough-modify-or-add-rules-files-for-llm-enabled-ides).

ai/amp/.message

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
2+
This command and rule-set is a work in progress. Currently we provide rules specific to one workflow:
3+
creating REST API sources and pipeline from legacy code, OpenAPI specs, REST API documentation but also from scratch.

ai/claude/.message

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
2+
This command and rule-set is a work in progress. Currently we provide rules specific to one workflow:
3+
creating REST API sources and pipeline from legacy code, OpenAPI specs, REST API documentation but also from scratch.

ai/cline/.message

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
2+
This command and rule-set is a work in progress. Currently we provide rules specific to one workflow:
3+
creating REST API sources and pipeline from legacy code, OpenAPI specs, REST API documentation but also from scratch.

ai/codex/.message

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
2+
This command and rule-set is a work in progress. Currently we provide rules specific to one workflow:
3+
creating REST API sources and pipeline from legacy code, OpenAPI specs, REST API documentation but also from scratch.

ai/cody/.message

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
2+
This command and rule-set is a work in progress. Currently we provide rules specific to one workflow:
3+
creating REST API sources and pipeline from legacy code, OpenAPI specs, REST API documentation but also from scratch.

ai/continue/.message

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
2+
This command and rule-set is a work in progress. Currently we provide rules specific to one workflow:
3+
creating REST API sources and pipeline from legacy code, OpenAPI specs, REST API documentation but also from scratch.

ai/copilot/.message

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
2+
This command and rule-set is a work in progress. Currently we provide rules specific to one workflow:
3+
creating REST API sources and pipeline from legacy code, OpenAPI specs, REST API documentation but also from scratch.

0 commit comments

Comments
 (0)