Instruction file imported from DubblePumper/creepypastaAI (
.github/instructions/copilotinctructions.instructions.md). Copyright stays with the author.
Make sure my project is orginized and well-structured. Use clear and descriptive names for files, functions, and variables. Follow best practices for code organization, such as separating concerns and keeping related code together.
When writing code, ensure it is clean, readable, and maintainable. Use comments where necessary to explain complex logic or important decisions. Avoid unnecessary complexity and strive for simplicity. When implementing features, consider edge cases and error handling. Write tests to ensure the code works as expected and to prevent regressions in the future. When refactoring or modifying existing code, ensure that the changes do not introduce new bugs and that the overall functionality remains intact. Use version control effectively to track changes and collaborate with others. When reviewing code, provide constructive feedback that helps improve the quality of the codebase. Focus on the code's functionality, readability, and adherence to best practices. When documenting the project, provide clear and concise explanations of how to use the code, its structure, and any important design decisions. Use README files, comments, and other documentation tools effectively.
use folders and subfolders to organize code logically. For example, separate source code from tests, and group related modules together.
When using libraries or frameworks, follow their conventions and best practices. Ensure that dependencies are well-managed and documented. When deploying or distributing the code, ensure that it is packaged correctly and that any necessary configurations are included. Provide clear instructions for setup and usage. When collaborating with others, communicate effectively and be open to feedback. Use pull requests for code reviews and discussions, and ensure that the code meets the project's standards before merging. When using version control, commit changes frequently with clear messages that describe the changes made. Use branches for new features or bug fixes to keep the main branch stable. When handling sensitive data or security concerns, follow best practices for data protection and ensure that sensitive information is not exposed in the codebase. When optimizing performance, profile the code to identify bottlenecks and apply appropriate optimizations without sacrificing readability or maintainability. When using third-party services or APIs, handle errors gracefully and provide fallbacks or alternative solutions where possible. Document any dependencies on external services clearly. When working with asynchronous code, ensure that it is handled correctly and that any potential issues are addressed proactively.
edit the README.md file to reflect these guidelines and best practices.
DO NOT CREATE, MAKE, WRITE TESTS.