1.4 KiB
Python GitHub Setup .cursorrules prompt file
Author: Jesse Naldo
What you can build
AI File Sorting Plugin for IDEs:Interactive AI File Organizing Dashboard:Intelligent File Organization Chatbot:Open Source File Classification Extension:AI-Powered Data Import Tool:
Benefits
Synopsis
Developers building Python-based AI file organization tools would benefit from this prompt to ensure code quality, security, and consistency.
Overview of .cursorrules prompt
The .cursorrules file provides a comprehensive configuration for a Python-based project. It outlines the coding style, naming conventions, and error handling practices to ensure code quality and consistency. The file specifies that the code should be well-commented, tested, and documented according to the Google Python Style Guide. Emphasis is placed on security, configuration management, and version control, recommending Git with GitHub Flow branching strategy. It also includes guidelines for logging, monitoring, dependency management, and accessibility, with CI/CD set up via GitHub Actions. The architecture promotes modular design and principles like DRY and Single Responsibility. Project-specific settings like testing with pytest and manual deployment strategies are included. This file aims to provide a coherent structure and best practices for developing a Python-based AI tool for file organization and content analysis.