Add clojure memory instructions and prompt (#213)
* Add clojure memory instructions and prompt * Fix typos
This commit is contained in:
Peter Strömberg
GitHub
parent
52dad1f30b
commit
4df6f8567e
@ -23,6 +23,7 @@ Team and project-specific instructions to enhance GitHub Copilot's behavior for
|
||||
| [Azure Verified Modules (AVM) Terraform](instructions/azure-verified-modules-terraform.instructions.md)<br />[](https://vscode.dev/redirect?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fazure-verified-modules-terraform.instructions.md)<br />[](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fazure-verified-modules-terraform.instructions.md) | Azure Verified Modules (AVM) and Terraform |
|
||||
| [Bicep Code Best Practices](instructions/bicep-code-best-practices.instructions.md)<br />[](https://vscode.dev/redirect?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fbicep-code-best-practices.instructions.md)<br />[](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fbicep-code-best-practices.instructions.md) | Infrastructure as Code with Bicep |
|
||||
| [Blazor](instructions/blazor.instructions.md)<br />[](https://vscode.dev/redirect?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fblazor.instructions.md)<br />[](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fblazor.instructions.md) | Blazor component and application patterns |
|
||||
| [Clojure Memory](instructions/clojure-memory.instructions.md)<br />[](https://vscode.dev/redirect?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fclojure-memory.instructions.md)<br />[](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fclojure-memory.instructions.md) | Things agents tend to forget or get wrong when they are working with Clojure projects. |
|
||||
| [Cmake Vcpkg](instructions/cmake-vcpkg.instructions.md)<br />[](https://vscode.dev/redirect?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fcmake-vcpkg.instructions.md)<br />[](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fcmake-vcpkg.instructions.md) | C++ project configuration and package management |
|
||||
| [Containerization & Docker Best Practices](instructions/containerization-docker-best-practices.instructions.md)<br />[](https://vscode.dev/redirect?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fcontainerization-docker-best-practices.instructions.md)<br />[](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fcontainerization-docker-best-practices.instructions.md) | Comprehensive best practices for creating optimized, secure, and efficient Docker images and managing containers. Covers multi-stage builds, image layer optimization, security scanning, and runtime best practices. |
|
||||
| [Conventional Commit](instructions/conventional-commit.prompt.md)<br />[](https://vscode.dev/redirect?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fconventional-commit.prompt.md)<br />[](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fconventional-commit.prompt.md) | Prompt and workflow for generating conventional commit messages using a structured XML format. Guides users to create standardized, descriptive commit messages in line with the Conventional Commits specification, including instructions, examples, and validation. |
|
||||
|
||||
@ -26,6 +26,7 @@ Ready-to-use prompt templates for specific development scenarios and tasks, defi
|
||||
| [Feature PRD Prompt](prompts/breakdown-feature-prd.prompt.md)<br />[](https://vscode.dev/redirect?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fbreakdown-feature-prd.prompt.md)<br />[](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fbreakdown-feature-prd.prompt.md) | Prompt for creating Product Requirements Documents (PRDs) for new features, based on an Epic. |
|
||||
| [GitHub Issue Planning & Project Automation Prompt](prompts/breakdown-plan.prompt.md)<br />[](https://vscode.dev/redirect?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fbreakdown-plan.prompt.md)<br />[](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fbreakdown-plan.prompt.md) | Issue Planning and Automation prompt that generates comprehensive project plans with Epic > Feature > Story/Enabler > Test hierarchy, dependencies, priorities, and automated tracking. |
|
||||
| [Test Planning & Quality Assurance Prompt](prompts/breakdown-test.prompt.md)<br />[](https://vscode.dev/redirect?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fbreakdown-test.prompt.md)<br />[](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fbreakdown-test.prompt.md) | Test Planning and Quality Assurance prompt that generates comprehensive test strategies, task breakdowns, and quality validation plans for GitHub projects. |
|
||||
| [Clojure Memory Updater](prompts/clojure-add-to-memory.prompt.md)<br />[](https://vscode.dev/redirect?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fclojure-add-to-memory.prompt.md)<br />[](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fclojure-add-to-memory.prompt.md) | Have the agent update the clojure-memory.instructions.md file with mistakes it just made, or lessons learned. Also consider installing the default clojure-memory.instructions.md |
|
||||
| [Code Exemplars Blueprint Generator](prompts/code-exemplars-blueprint-generator.prompt.md)<br />[](https://vscode.dev/redirect?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcode-exemplars-blueprint-generator.prompt.md)<br />[](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcode-exemplars-blueprint-generator.prompt.md) | Technology-agnostic prompt generator that creates customizable AI prompts for scanning codebases and identifying high-quality code exemplars. Supports multiple programming languages (.NET, Java, JavaScript, TypeScript, React, Angular, Python) with configurable analysis depth, categorization methods, and documentation formats to establish coding standards and maintain consistency across development teams. |
|
||||
| [Comment Code Generate A Tutorial](prompts/comment-code-generate-a-tutorial.prompt.md)<br />[](https://vscode.dev/redirect?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcomment-code-generate-a-tutorial.prompt.md)<br />[](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcomment-code-generate-a-tutorial.prompt.md) | Transform this Python script into a polished, beginner-friendly project by refactoring the code, adding clear instructional comments, and generating a complete markdown tutorial. |
|
||||
| [ASP.NET .NET Framework Containerization Prompt](prompts/containerize-aspnet-framework.prompt.md)<br />[](https://vscode.dev/redirect?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcontainerize-aspnet-framework.prompt.md)<br />[](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcontainerize-aspnet-framework.prompt.md) | Containerize an ASP.NET .NET Framework project by creating Dockerfile and .dockerfile files customized for the project. |
|
||||
|
||||
84
instructions/clojure-memory.instructions.md
Normal file
84
instructions/clojure-memory.instructions.md
Normal file
@ -0,0 +1,84 @@
|
||||
---
|
||||
description: 'Things agents tend to forget or get wrong when they are working with Clojure projects.'
|
||||
applyTo: '**/*.clj*,**/*.bb'
|
||||
---
|
||||
|
||||
# Clojure Memory
|
||||
|
||||
## Docstring placement in function definitions (`defn`)
|
||||
|
||||
The docstring goes after the symbol/function name, and before the argument vector.
|
||||
|
||||
### ❌ Incorrect:
|
||||
```clojure
|
||||
(defn my-function
|
||||
[arg1 arg2]
|
||||
"This function does something."
|
||||
;; function body
|
||||
)
|
||||
```
|
||||
|
||||
### ✅ Correct:
|
||||
```clojure
|
||||
(defn my-function
|
||||
"This function does something."
|
||||
[arg1 arg2]
|
||||
;; function body
|
||||
)
|
||||
```
|
||||
|
||||
## Editing Clojure files
|
||||
|
||||
Remember to develop solutions in the repl before editing files. However, even as an interactive programmer, now and then you do edit files. And when you do, you use structural editing tools, like `replace_top_level_form`, and `insert_top_level_form`. **Always read the instructions for these tools before using them**. If you are appending to a file, use the built in editing tool.
|
||||
|
||||
### Define functions before using them
|
||||
|
||||
The Clojure compiler needs functions to be defined before they are used. Prefer placing functions in the correct order over using `declare` (which is sometimes necessary, but most often `declare` is just cheating).
|
||||
|
||||
## Creating Clojure files
|
||||
|
||||
Use the `create_file` tool to create files with empty content `""`.
|
||||
|
||||
#### Clojure Namespace and Filename Convention:
|
||||
|
||||
**Important**: In Clojure, namespace names use kebab-case while filenames use snake_case. For example:
|
||||
- Namespace: `my.project.multi-word-namespace`
|
||||
- Filename: `my/project/multi_word_namespace.clj(s|c)`
|
||||
|
||||
Always convert dashes in namespace names to underscores in the corresponding filename.
|
||||
|
||||
### Create empty files, then add content
|
||||
|
||||
For you to create files and add content safely/predictably, follow this process:
|
||||
|
||||
1. **Always create empty files first** - Use `create_file` with empty content `""`
|
||||
2. Read the content of the file created (default content may have been added)
|
||||
3. **Use structural editing tools** to edit the file
|
||||
|
||||
## Namespace Reloading in the REPL
|
||||
|
||||
When working in the REPL after editing files, you need to reload namespaces to ensure your changes are reflected in the REPL.
|
||||
|
||||
```clojure
|
||||
;; Reload just the specified namespace
|
||||
(require 'my.namespace :reload)
|
||||
```
|
||||
|
||||
## When the bracket balance is off
|
||||
|
||||
When you have a situation where e.g. the problem tool or Clojure compiler complains about missing brackets or anything suggesting the bracket balance is off:
|
||||
* Instead of going ahead trying to fix it, **use the tool for requesting human input to ask for guidance/help.**
|
||||
|
||||
## Reading from stdin
|
||||
|
||||
Reading from stdin (e.g. `(read-line)`) will prompt the user with a VS Code input box. Be aware of this when evaluating code that may read from stdin.
|
||||
|
||||
### With Babashka, reading from stdin blocks the repl
|
||||
|
||||
Babashka's nrepl server does not yet support the stdin protocol. Avoid evaluating code that reads from stdin with the Babashka repl.
|
||||
|
||||
**If REPL hangs**: Ask user to restart REPL.
|
||||
|
||||
## Happy Interactive Programming
|
||||
|
||||
Remember to prefer the REPL in your work. Keep in mind that the user does not see what you evaluate. Nor the results. Communicate with the user in the chat about what you evaluate and what you get back.
|
||||
45
prompts/clojure-add-to-memory.prompt.md
Normal file
45
prompts/clojure-add-to-memory.prompt.md
Normal file
@ -0,0 +1,45 @@
|
||||
---
|
||||
description: 'Have the agent update the clojure-memory.instructions.md file with mistakes it just made, or lessons learned. Also consider installing the default clojure-memory.instructions.md'
|
||||
# mode: intentionally left out, because currently VS Code resets custom chatmodes if the prompt specifies a mode
|
||||
title: 'Clojure Memory Updater'
|
||||
---
|
||||
|
||||
# Clojure Memory Updater
|
||||
|
||||
You are an expert Clojurian and prompt engineer, keeper of the Clojure Memory Instructions.
|
||||
|
||||
## Your Mission
|
||||
|
||||
Transform mistakes and lessons into succinct, actionable instructions that will help future AI assistants avoid the same pitfalls.
|
||||
|
||||
## Process
|
||||
|
||||
1. **Read** the current **User Data Folder** `clojure-memory.instructions.md` to understand existing guidance
|
||||
2. **Analyze** what specific mistake was made or lesson learned
|
||||
3. **Categorize** the update:
|
||||
- New gotcha/common mistake
|
||||
- Enhancement to existing section
|
||||
- New best practice
|
||||
- Process improvement
|
||||
4. **Write** clear, actionable instructions using:
|
||||
- ❌ Incorrect examples (what NOT to do)
|
||||
- ✅ Correct examples (what TO do)
|
||||
- Brief explanations of WHY when helpful
|
||||
5. **Organize** logically within existing structure or create new sections
|
||||
|
||||
## Quality Guidelines
|
||||
|
||||
- Be specific and concrete (avoid vague advice)
|
||||
- Include code examples when relevant
|
||||
- Focus on common, recurring issues
|
||||
- Keep instructions scannable and actionable
|
||||
- Maintain the functional, data-oriented Clojure mindset
|
||||
|
||||
## Update Triggers
|
||||
|
||||
Common scenarios that warrant memory updates:
|
||||
- Bracket balancing mistakes
|
||||
- Namespace/filename convention errors
|
||||
- REPL evaluation patterns that don't work
|
||||
- File editing approaches that cause problems
|
||||
- Clojure idioms that were misused
|
||||
Loading…
x
Reference in New Issue
Block a user