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
* Remove CLA requirement since quarto CLI is MIT now
* We have CONTRIBUTING.md in .github
* Enhance contribution guidelines and templates to clarify AI tool usage and reporting processes
|`.claude/rules/<feature>/`| When paths match | Feature-specific conventions|
266
+
|`llm-docs/`| When explicitly read | Architectural deep dives|
266
267
267
268
**Personal overrides:** Create `CLAUDE.local.md` (gitignored) for personal preferences like preferred shell syntax or workflow customizations. This file is loaded alongside the project CLAUDE.md but won't be committed.
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.md
+18-3Lines changed: 18 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,6 +9,23 @@ You can contribute in many ways:
9
9
- By submitting Pull Request (PR) to fix opened issues
10
10
- By submitting Pull Request (PR) to suggest new features (it is considered good practice to open an issue for discussion before working on a pull request for a new feature).
11
11
12
+
## Opening an issue
13
+
14
+
Before opening an issue, please search [existing issues](https://github.com/quarto-dev/quarto-cli/issues) to avoid duplicates.
15
+
16
+
When reporting a bug, include a minimal reproducible example. For feature requests, describe the use case and expected behavior.
17
+
18
+
### Using AI tools to investigate
19
+
20
+
If you are using an AI assistant to help investigate a bug or prepare an issue, point it to the Quarto codebase before asking it to analyze the problem:
21
+
22
+
-**[DeepWiki](https://deepwiki.com/quarto-dev/quarto-cli)** — AI-indexed documentation for the repository. Available as a web UI for human queries and as an [MCP server](https://docs.devin.ai/work-with-devin/deepwiki-mcp) to give your AI assistant direct access. Useful for understanding architecture, finding relevant source files, and asking questions about how Quarto works internally.
23
+
-**[Context7](https://context7.com)** — Provides up-to-date Quarto documentation and related tool docs. Available as a web UI, a [cli tool](https://context7.com/docs/clients/cli) and as an [MCP server](https://context7.com/docs/resources/all-clients) so AI assistants can fetch current docs on demand.
24
+
-**`https://quarto.org/llms.txt`** — Machine-readable index of Quarto documentation, following the [llms.txt convention](https://llmstxt.org/). Point your AI assistant at this URL to give it a structured map of available documentation.
25
+
-**Clone the repo** — AI tools that can run code or search files benefit from a local clone. Cloning the repository lets the AI search source files, trace code paths, and verify behavior directly rather than relying on potentially outdated training data.
26
+
27
+
Grounding your AI assistant in the actual codebase leads to more accurate root cause analysis and better-quality issue reports.
28
+
12
29
## To submit a contribution using a Pull Request
13
30
14
31
1.[Fork](https://github.com/quarto-dev/quarto-cli/fork) the repository, clone it locally, and make your changes in a new branch specific to the PR. For example:
@@ -25,8 +42,6 @@ You can contribute in many ways:
25
42
$ git checkout -b bugfix/myfix
26
43
```
27
44
28
-
2. For significant changes (e.g more than small bug fixes), ensure that you have signed the [individual](https://posit.co/wp-content/uploads/2023/04/2023-03-13_TC_Indiv_contrib_agreement.pdf) or [corporate](https://posit.co/wp-content/uploads/2023/04/2023-03-13_TC_Corp_contrib_agreement.pdf) contributor agreement as appropriate. You can send the signed copy to <[email protected]>.
29
-
30
-
3. Submit the [pull request](https://help.github.com/articles/using-pull-requests). It is ok to submit as a draft if you are still working on it but would like some feedback from us. It is always good to share in the open that you are working on it.
45
+
2. Submit the [pull request](https://help.github.com/articles/using-pull-requests). It is ok to submit as a draft if you are still working on it but would like some feedback from us. It is always good to share in the open that you are working on it.
31
46
32
47
We'll try to be as responsive as possible in reviewing and accepting pull requests. Very much appreciate your contributions!
Copy file name to clipboardExpand all lines: .github/ISSUE_TEMPLATE/bug_report.yml
+2Lines changed: 2 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -22,6 +22,8 @@ body:
22
22
23
23
Finally, so that we can get the most out of your bug report, consider reading our ["Bug Reports" guide](https://quarto.org/bug-reports.html).
24
24
25
+
**Using an AI assistant to investigate?** Point it to the codebase first — see [Using AI tools to investigate](https://github.com/quarto-dev/quarto-cli/blob/main/.github/CONTRIBUTING.md#using-ai-tools-to-investigate) in CONTRIBUTING.md.
Copy file name to clipboardExpand all lines: .github/pull_request_template.md
+16-4Lines changed: 16 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,9 +2,7 @@ Welcome to the quarto GitHub repo!
2
2
3
3
We are always happy to hear feedback from our users.
4
4
5
-
To file a _pull request_, please follow these instructions carefully: <https://yihui.org/issue/#bug-reports>
6
-
7
-
If you're a collaborator from outside `quarto-dev` making changes larger than a typo, please make sure you have filed an [individual](https://posit.co/wp-content/uploads/2023/04/2023-03-13_TC_Indiv_contrib_agreement.pdf) or [corporate](https://posit.co/wp-content/uploads/2023/04/2023-03-13_TC_Corp_contrib_agreement.pdf) contributor agreement. You can send the signed copy to <[email protected]>.
5
+
To file a _pull request_, please follow these instructions : <https://github.com/quarto-dev/quarto-cli?tab=contributing-ov-file>
8
6
9
7
Also, please complete and keep the checklist below.
10
8
@@ -22,9 +20,23 @@ print("Hello Quarto!")
22
20
23
21
I have (if applicable):
24
22
25
-
-[ ] filed a [contributor agreement](https://github.com/quarto-dev/quarto-cli/blob/main/CONTRIBUTING.md).
26
23
-[ ] referenced the GitHub issue this PR closes
27
24
-[ ] updated the appropriate changelog in the PR
28
25
-[ ] ensured the present test suite passes
29
26
-[ ] added new tests
30
27
-[ ] created a separate documentation PR in [Quarto's website repo](https://github.com/quarto-dev/quarto-web/) and linked it to this PR
28
+
29
+
<!-- If an AI assistant helped prepare this PR, uncomment and complete this section:
30
+
31
+
<details>
32
+
<summary>AI-assisted PR</summary>
33
+
34
+
- **AI tool used**: e.g., Claude Code, Copilot, ChatGPT
Copy file name to clipboardExpand all lines: src/resources/language/README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -46,4 +46,4 @@ We welcome contributions of additional languages! To contribute a localization:
46
46
47
47
2. Translate the English strings therein to the target language.
48
48
49
-
3. Submit a [pull request](https://help.github.com/articles/using-pull-requests) with your new language translation. Before doing this please ensure that you have signed the [individual](https://posit.co/wp-content/uploads/2023/04/2023-03-13_TC_Indiv_contrib_agreement.pdf) or [corporate](https://posit.co/wp-content/uploads/2023/04/2023-03-13_TC_Corp_contrib_agreement.pdf) contributor agreement as appropriate. You can send the signed copy to [jj\@rstudio.com](mailto:[email protected]).
49
+
3. Submit a [pull request](https://help.github.com/articles/using-pull-requests) with your new language translation.
0 commit comments