Fix markdown lint

CHANGELOG.md

@@ -5,19 +5,35 @@ All notable changes to the awesome-windsurf repository will be documented in thi
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [0.2.3] - 2024-12-14
+## [0.2.5] - 2024-12-14
+
+### Added
+
+- Added computerK's Global Rules prompt to prompts directory
+- Created dedicated prompts directory with README
+- Added custom prompts section to main README
+
+### Changed
+
+- Improved markdown formatting and consistency
+- Simplified installation instructions
+
+## [0.2.4] - 2024-12-14
 
 ### Added
+
 - Added link to official Cascade documentation in Rules Files section
 
-## [0.2.2] - 2024-12-14
+## [0.2.3] - 2024-12-14
 
 ### Added
+
 - Added markdownlint configuration and GitHub Actions workflow for markdown linting
 
-## [0.2.1] - 2024-12-14
+## [0.2.2] - 2024-12-14
 
 ### Added
+
 - Added direct link to Codeium documentation in the "Please Read" section
 - Added clarification about project's community focus and relationship to official documentation
 - Added community wishlist section with implementation status tracking
@@ -26,6 +42,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Added link to custom Jest reporter for handling special characters in chat
 
 ### Changed
+
 - Improved documentation clarity by making documentation links more accessible
 - Simplified installation section to focus on package managers only
 - Reorganized installation instructions into OS-specific sections
@@ -35,23 +52,50 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Made issue descriptions more realistic and community-driven
 - Converted community wishlist to table format with status indicators
 
-## [0.2.0] - 2024-12-14
+## [0.2.1] - 2024-12-14
 
 ### Added
+
 - New common issues documentation:
   - Windsurf rules files limitations and solutions
   - Allowed commands configuration troubleshooting
 - More detailed issue descriptions and solutions
 - Platform-specific installation instructions for all major OS
 
 ### Changed
+
 - Converted common issues to table format for better readability
 - Maintained professional tone in Discord link description
 - Improved documentation organization and readability
 
+## [0.2.0] - 2024-12-14
+
+### Added
+
+- Initial repository structure
+- README.md with comprehensive sections:
+  - Official Resources (Discord, Website, Documentation, Changelog)
+  - Getting Started guide
+  - Known Issues & Solutions section
+  - Placeholders for Tips, Themes, and Troubleshooting
+  - Community section
+  - Contributing guidelines
+- Links to official Codeium resources:
+  - Common Issues documentation
+  - Changelog
+  - Discord community
+- Added Prompt Libraries section with Cursor.Directory link
+- Added Windsurf logo
+
+### Changed
+
+- Reorganized sections for better readability
+- Added disclaimer about community-driven nature
+
 ## [0.1.0] - 2024-12-14
 
 ### Added
+
 - Initial repository structure
 - README.md with comprehensive sections:
   - Official Resources (Discord, Website, Documentation, Changelog)
@@ -68,6 +112,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Added Windsurf logo
 
 ### Changed
+
 - Reorganized sections for better readability
 - Added disclaimer about community-driven nature
 

README.md

@@ -6,14 +6,15 @@
 
 [![Awesome](https://awesome.re/badge.svg)](https://awesome.re)
 
 **This is not an official Codeium or Windsurf resource, but rather a community-driven endeavor**
 
 > Our goal is to complement, not duplicate, the official documentation. We focus on community-contributed resources, tips, and solutions that enhance the Windsurf experience. For official features and usage documentation, please refer to the [Codeium Documentation](https://docs.codeium.com/getstarted/overview).
 
 ## Contents
-- [Official Resources](#official-resources)
-- [Service Status](#service-status)
 - [Getting Started](#getting-started)
+- [Official Resources](#official-resources)
+- [Please Read The Docs](#please-read-the-docs)
+- [Custom Prompts](#custom-prompts)
 - [FAQ](#faq)
 - [Known Issues & Solutions](#known-issues--solutions)
 - [Tips and Tricks](#tips-and-tricks)
@@ -22,24 +23,25 @@
 - [Community](#community)
 - [Contributing](#contributing)
 
+## Getting Started
+### Installation
+For installation instructions, please refer to the [official website](https://www.codeium.com/windsurf).
+
 ## Official Resources
 - [Windsurf Discord](https://discord.com/invite/3XFf78nAx5) - Join the Windsurf community on Discord
 - [Windsurf Website](https://www.codeium.com/windsurf) - Official website and download
 - [Codeium Documentation](https://docs.codeium.com/windsurf/getting-started) - Official documentation
 - [Changelog](https://codeium.com/changelog) - Stay updated with the latest Windsurf features and improvements
 
-## Service Status
-Monitor AI service health directly:
-- [Anthropic Status](https://status.anthropic.com) - Claude API availability and incidents
-- [OpenAI Status](https://status.openai.com) - GPT-4 and other OpenAI services status
-
 ## Please Read The Docs Before Asking For Help
 
 We are trying to build a community around Windsurf that is self-sufficient and supportive. Before asking for help in Discord or emailing Codeium support, please take a few minutes to read the [Codeium documentation](https://docs.codeium.com/getstarted/overview) linked above.
 
-## Getting Started
-### Installation
-For installation instructions, please refer to the [official website](https://www.codeium.com/windsurf).
+## Custom Prompts
+
+Check out our [prompts directory](prompts/) for a collection of community-contributed prompts and guidelines, including:
+
+- [Global Rules](prompts/global-rules.md) - A comprehensive set of coding guidelines by computerK
 
 ## FAQ
 
@@ -81,6 +83,9 @@
 ## Troubleshooting
 *Coming soon - We will collect common issues and solutions here*
 
+## Community
+- [Windsurf Discord](https://discord.com/invite/3XFf78nAx5) - Join the Windsurf community on Discord
+
 ## Contributing
 We welcome contributions! If you have suggestions, tips, or resources to add:
 1. Fork this repository

prompts/README.md

@@ -0,0 +1 @@
+# Custom Prompts\n\nThis directory contains custom prompts for various purposes. Each prompt should be in its own file with clear documentation about its purpose and usage.

prompts/global-rules.md

@@ -0,0 +1,59 @@
+# Global Rules
+
+This set of guidelines ensures consistency, clarity, performance, and maintainability across all languages and projects. Always apply these principles to produce clean, understandable, and efficient code.
+
+## Code Style and Readability
+
+1. **Clarity Over Brevity**:  
+   - Favor understandable code over clever tricks.  
+   - Prioritize legibility and maintainability over saving a few lines.
+2. **Consistent Naming Conventions**:  
+   - Use descriptive, self-explanatory names for variables, functions, classes, and modules.  
+   - Follow language-specific naming conventions (e.g., `snake_case` for Python, `camelCase` for JavaScript) and remain consistent throughout the codebase.
+3. **Consistent Formatting**:  
+   - Adhere to a uniform indentation style, spacing, and line width.  
+   - Use automated tools (linters, formatters) to enforce consistency and reduce manual overhead.
+4. **Comments That Add Value**:  
+   - Write comments to explain the "why" behind complex logic, not just the "what."  
+   - Remove or avoid redundant comments that restate the obvious.
+5. **Small, Single-Responsibility Functions**:  
+   - Keep functions concise and focused on doing one thing well.  
+   - Break larger functionalities into smaller, reusable units that are easier to test and maintain.
+
+## Architecture and Modularity
+
+1. **Encapsulation of Complexity**:  
+   - Hide complex logic behind clear interfaces or modules.  
+   - Present a simple, well-documented API to callers while keeping internals flexible and interchangeable.
+2. **Decouple Components**:  
+   - Design modules with minimal direct knowledge of each other's implementations.  
+   - Use interfaces, abstract classes, or dependency injection to reduce coupling and improve testability and flexibility.
+3. **DRY (Don't Repeat Yourself)**:  
+   - Factor out repetitive patterns into shared functions or classes.  
+   - Refactor early and often to prevent code drift and bloat over time.
+
+## Error Handling and Testing
+
+1. **Fail Fast, Fail Loud**:  
+   - Validate assumptions early, return or throw errors as soon as something unexpected happens.  
+   - Provide clear error messages that help identify the root cause quickly.
+2. **Testability as a Priority**:  
+   - Write code that is easy to test in isolation.  
+   - Separate pure logic from side effects, use dependency injection, and ensure complex logic resides in testable units.
+3. **Thorough Input Validation**:  
+   - Check all inputs for correctness, sanity, and security risks before processing.  
+   - Guard against malformed data, null references, or out-of-bound values.
+
+## Performance and Resource Management
+
+1. **Appropriate Data Structures and Algorithms**:  
+   - Choose data structures and algorithms best suited for the problem to ensure reasonable time and space complexity.  
+   - Opt for clarity first, and only optimize further if and when performance profiling indicates a need.
+2. **Avoid Premature Optimization**:  
+   - Start with a clean, readable solution.  
+   - Measure performance with profiling tools and address hotspots instead of guessing where optimization is needed.
+3. **Resource Lifecycle Awareness**:  
+   - Properly manage memory, file handles, network connections, and other resources.  
+   - Use language-specific best practices (e.g., RAII, `with` statements, finally blocks) to ensure proper cleanup.
+
+*Note: These guidelines are meant to be a living document. Feel free to suggest improvements or additions through pull requests.*