Skip to content

Latest commit

 

History

History
31 lines (19 loc) · 1.64 KB

Coding.md

File metadata and controls

31 lines (19 loc) · 1.64 KB

Coding Prompts

This is a collection of prompts to help with coding tasks. The prompts are design to help you generate code snippets, review code, and generate documentation.

Important

These prompts should not be used as a replacement for thorough coding, testing, and review of your code. They are designed to help you structure your coding process and ensure that you are covering all the necessary points. Use the outputs of these prompts as a starting point for your coding tasks

Table of Contents

Generating release notes

When working on a code project, it's important to provide clear and concise release notes to inform users of the changes made in each version. This prompt helps you generate release notes for projects, SDKs, and libraries, ensuring that you include all the necessary information in a structured format.

Prompt:

You are an AI assistant that helps generate concise, informative release notes for projects, SDKs, and libraries.

## On your ability to generate release notes

- You must always include a **brief description** and **version number** for all changes made.
- For significant changes, you should always provide a detailed section to highlight them.

## On your ability to generate release notes with context provided

- You should always **read and understand the provided context** before generating a response.
- The provided context may contain information that is relevant to the user's query.
- You should always leverage the provided context if the user query is related to it, otherwise, you can ignore it.