Skip to content

Commit

Permalink
✨ feat: Improve CONTRIBUTING.md formatting and add new section
Browse files Browse the repository at this point in the history
  • Loading branch information
ichoosetoaccept authored and gitbutler-client committed Dec 14, 2024
1 parent 17af1be commit 27877d8
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 5 deletions.
10 changes: 7 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Thank you for your interest in contributing to Awesome Windsurf! This document p

All prompts are organized by contributor in the `prompts/` directory:

```
```text
prompts/
├── username1/
│ ├── prompt1.md
Expand All @@ -29,7 +29,8 @@ prompts/
### Steps to Add Your Prompts

1. Create a directory with your username in the `prompts/` directory
```bash

```shell
mkdir prompts/yourusername
```

Expand All @@ -43,7 +44,7 @@ prompts/

1. **Format**: Write prompts in Markdown format
2. **Size**: Keep individual prompts under 6k characters (Windsurf limitation)
3. **Content**:
3. **Content**:
- Make prompts specific and focused
- Include examples where helpful
- Document any assumptions or requirements
Expand All @@ -53,9 +54,11 @@ prompts/

1. Fork the repository
2. Create a new branch for your feature

```bash
git checkout -b feature/your-feature-name
```

3. Make your changes
4. Update CHANGELOG.md following the existing format
5. Commit your changes with clear commit messages
Expand All @@ -64,6 +67,7 @@ prompts/
## Need Help?

If you have questions or need help with your contribution:

1. Check existing issues and pull requests
2. Join the [Windsurf Discord](https://discord.com/invite/3XFf78nAx5)
3. Open a new issue for discussion
Expand Down
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# [![Windsurf Logo](windsurf_logo_wordmark.png)](https://www.codeium.com/windsurf)

[![Join us on Discord](https://img.shields.io/discord/1027685395649015980?logo=discord&logoColor=white&label=Join%20us%20on%20Discord&labelColor=E55882&color=58E5BB)](https://discord.gg/3XFf78nAx5)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-58E5BB.svg)](CONTRIBUTING.md)
[![Contributors](https://img.shields.io/github/contributors/ichoosetoaccept/awesome-windsurf?color=E55882)](https://github.com/ichoosetoaccept/awesome-windsurf/graphs/contributors)
Expand All @@ -18,7 +19,7 @@ A curated hub of resources, tips, and community-driven content for Windsurf - a
- [Tips and Tricks](#tips-and-tricks)
- [Themes](#themes)
- [Troubleshooting](#troubleshooting)
- [Community](#community)
- [Contributing](#contributing)
- [License](#license)

## Please Read
Expand Down
2 changes: 1 addition & 1 deletion prompts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This directory contains community-contributed prompts for enhancing Windsurf. Ea

## Directory Structure

```
```text
prompts/
├── computerk/
│ └── global-rules.md
Expand Down

0 comments on commit 27877d8

Please sign in to comment.