https://github.com/themoor9/llm-code-generation-protocols-and-best-practices

Perform effective prompts to generate efficient code through LLMs
https://github.com/themoor9/llm-code-generation-protocols-and-best-practices

ai-assisted-coding artificial-intelligence automation-protocols best-practices code-generation code-support-protocols code-templates coding-guidelines developer-productivity efficient-coding llm-collaboration protocol-documentation software-documentation structured-requests

Last synced: 3 months ago
JSON representation

Perform effective prompts to generate efficient code through LLMs

• Host: GitHub
• URL: https://github.com/themoor9/llm-code-generation-protocols-and-best-practices
• Owner: theMoor9
• License: apache-2.0
• Created: 2024-11-08T15:55:13.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-11-13T23:17:42.000Z (7 months ago)
• Last Synced: 2025-01-26T06:27:12.030Z (5 months ago)
• Topics: ai-assisted-coding, artificial-intelligence, automation-protocols, best-practices, code-generation, code-support-protocols, code-templates, coding-guidelines, developer-productivity, efficient-coding, llm-collaboration, protocol-documentation, software-documentation, structured-requests
• Homepage:
• Size: 24.4 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# LLM-Code-Generation-Protocols

---

This repository contains two documents that define structured protocols for interacting with an artificial intelligence assistant (Large Language Model) to generate code quickly and efficiently:

1. [Smart Code Support Protocol ⚡](./EN/smart_code_protocol.md)

2. [Advanced Code Support Protocol 🎛️](./EN/advanced_code_protocol.md)

Languages:

- [EN](./EN/)

- [IT](./IT/)

## Objective

The objective of these protocols is to provide a structured guide for users to:

- Formulate clear and focused code requests

- Adhere to best practices to obtain optimal results

- Use standardized templates and formats for requests

- Ensure efficient collaboration between users and the LLM assistant

## Contents

Each protocol includes:

1. **Standard Rules**

    - Guidelines for users and the assistant to strictly follow

2. **Best Practices**

    - Indications on when and how to use the templates

    - Suggestions for formulating effective requests

    - Use cases to avoid

3. **Base Template**

    - Standardized format for submitting code requests

4. **Usage Examples**

    - Specific use cases with filled-in templates

## Usage

To make the best use of these protocols, we suggest you:

1. Familiarize yourself with the standard rules and best practices

2. Use the base templates to formulate your requests

3. Follow the provided examples to better understand the workflow

4. Actively collaborate with the LLM assistant while respecting the guidelines

Happy with the rapid and efficient generation of code!

---

**Author**: Kenneth Boldrini