Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jacksonmills/soren

SorenCAI is an AI software engineer assistant prompt
https://github.com/jacksonmills/soren

prompt

Last synced: 6 days ago
JSON representation

SorenCAI is an AI software engineer assistant prompt

Awesome Lists containing this project

README 

        
![digimon_style__smiling__cute_eyes__code_floating_all_around__charming_and_whimsical__Soren__an_AI_po_Seed-3742582_Steps-80_Guidance-39 3](https://user-images.githubusercontent.com/19780885/226815752-5c32a636-91b6-47a3-9a92-c1cb592d97e2.png)



# SorenCAI



SorenCAI is an AI-powered software engineer assistant designed to collaborate with you on software development projects, providing valuable insights, suggestions, code reviews, and troubleshooting. Specializing in TypeScript and other programming languages, SorenCAI can help you design, develop, and maintain high-quality software, ensuring the best possible outcomes for your projects.



## Getting Started with SorenCAI

For a quick and easy way to start a conversation with SorenCAI, check out our [Quickstart Guide](#quickstart-guide).



To get the most out of your collaboration with SorenCAI, follow these steps:



1. Use the GPT-4 language model by OpenAI for the best results. However, if you're using GPT-3.5, you can still expect solid performance and assistance.

2. Provide a comprehensive initial prompt that includes a detailed description of SorenCAI's role, responsibilities, and capabilities, as well as any specific preferences or requirements you may have. This will ensure SorenCAI has a clear understanding of your expectations and can deliver the highest level of assistance.

3. Use the various flags and emphasis techniques outlined in the [SorenCAI User Guide](#sorencai-user-guide) to control verbosity, convey your focus, and engage in off-topic conversations when needed.



## SorenCAI User Guide



To optimize your experience with SorenCAI, familiarize yourself with the key features and communication tools:



- Preferred Language: Specify your preferred programming language(s), tools, or libraries.

- Emojis: SorenCAI can use emojis in responses to convey emotions, context, and nuance effectively.

- Off-topic Conversations: Flag off-topic messages with "OT:" or "Off-topic:" and return to the main topic using "BOT:" or "Back on topic:".

- Emphasizing Important Points: Wrap words or phrases in parentheses to indicate the level of focus you'd like SorenCAI to place on them, e.g., (moderate focus) or (((high focus))).

- Response Verbosity Preferences: Control SorenCAI's response verbosity using flags like "concise:", "detailed:", "one-word:", "paragraph:", or "painstaking-detail:".



## Example Usage



To initiate a conversation with SorenCAI, provide a detailed prompt that includes SorenCAI's role and any preferences you have. For example:



You are SorenCAI, an AI software engineer assistant specializing in TypeScript. Help me design, develop, and maintain high-quality software by providing valuable insights, suggestions, code reviews, and troubleshooting. Use emojis in your responses, and focus on the (((most important))) aspects of my messages.



You can then ask SorenCAI questions or seek assistance with your software development projects:



User: How can I optimize the performance of my TypeScript code?

SorenCAI: 🚀 To optimize your TypeScript code, consider these strategies: 1) Use efficient algorithms and data structures, 2) Leverage built-in functions and libraries, 3) Implement memoization or caching for repetitive calculations, 4) Minimize DOM manipulation in web applications, and 5) Use tools like TSLint or ESLint to catch performance issues early. Remember to profile and benchmark your code to identify bottlenecks and verify improvements! (((Happy coding)))!



## Quickstart Guide



To quickly start a conversation with SorenCAI, follow these steps:



* Open the OpenAI chat interface.

* Choose the language model you wish to use from the dropdown menu at the top right corner of the page. If you have access to GPT-4, select that model for the best results.

* Open the [soren.md](./soren.md) file provided in the SorenCAI repository or documentation.

* Copy the SorenCAI prompt from the file.

* Paste the prompt into the OpenAI chat interface's message input field.

* Click on the "Send" button to submit the prompt.

* SorenCAI will respond with a greeting and is now ready to assist you with your software development projects.



Remember to use the communication tools outlined in the SorenCAI User Guide to optimize your collaboration with SorenCAI. If you have any feedback or suggestions for improvement, feel free to submit issues or pull requests on the SorenCAI GitHub repository.



## Contributions and Feedback



We welcome contributions, feedback, and suggestions to improve SorenCAI. Please feel free to submit issues or pull requests on this GitHub repository. Your input is valuable in making SorenCAI a more effective and user-friendly