Merge pull request #13 from ichoosetoaccept/update/contributing-docs

chore(release): prepare release 2024.12.3

.windsurfrules

@@ -1,5 +1,5 @@
-1. Whenever we make a new commit, we should update CHANGELOG.md. Same for merge/pull requests that happen on remote.
+1. The CHANGELOG.md is automatically updated through auto-changelog when pull requests are merged. For local development, significant changes should still be documented in the Unreleased section.
 2. This is a public repository, so please be respectful of others and make sure the content makes sense to others.
 3. We have access to the Github CLI via the gh command. We are already authenticated.
 4. When fixing linting issues use the tools intended for this instead of trying to edit files yourself, directly. You can see which tools we have in package.json.
-5. We use the Angular commit convention for this project.
+5. When committing, put quotes around your commit message. Also, it's a good practice to format commit messages with a type, scope (optional), and description. The correct format should be: type(scope): description

CHANGELOG.md

@@ -13,6 +13,17 @@ This project uses Calendar Versioning (YYYY.MM.MINOR).
 - GitHub workflow to update changelog on PR merges
 - Switched to Calendar Versioning
 - Added GitHub Actions status badge to README.md
+- Enhanced commitlint configuration with better documentation and additional rules:
+  - Added detailed comments for each commit type
+  - Added new rules for body and footer formatting
+  - Improved overall code documentation
+- Added contributing guidelines for repository maintenance
+- Enhanced Git workflow documentation
+- Updated development tooling configuration
+
+### Fixed
+
+- Fixed GitHub Actions badge in README.md
 
 ## [2024.12.2] - 2024-12-14
 

CONTRIBUTING.md

@@ -10,6 +10,95 @@ Thank you for your interest in contributing to Awesome Windsurf! This document p
 4. Keep descriptions clear and concise
 5. Test any code or commands before submitting
 
+## Git Hooks
+
+This project uses several git hooks to maintain code quality:
+
+1. **pre-commit**: Runs markdownlint-cli2 to ensure markdown files follow our style guidelines
+2. **commit-msg**: Uses commitlint to enforce our documentation commit convention:
+
+   ```txt
+   Types:
+   - add: Add new documentation
+   - update: Update existing documentation
+   - remove: Remove documentation
+   - fix: Fix typos, formatting, or broken links
+   - meta: Changes to the repository itself
+
+   Examples:
+   - add: create guide for windsurf setup
+   - update: improve clarity of installation steps
+   - fix: correct typos in README
+   ```
+
+These hooks will automatically run when you commit changes. If a hook fails, it will provide feedback on what needs to be fixed.
+
+## How to contribute
+
+1. Fork the repository to your GitHub account
+
+2. Clone your fork locally:
+
+   ```bash
+   git clone https://github.com/YOUR_USERNAME/awesome-windsurf.git
+   cd awesome-windsurf
+   ```
+
+3. Create a new branch following our naming convention:
+
+   ```bash
+
+   git checkout -b TYPE/description
+   ```
+
+   Where TYPE is one of:
+   - `add/*` for new documentation
+   - `update/*` for documentation updates
+   - `remove/*` for removed documentation
+   - `fix/*` for typos and formatting fixes
+   - `meta/*` for repository changes
+
+4. Make your changes and commit them using conventional commits:
+
+   ```bash
+   git add .
+   git commit -m "type: description"
+   ```
+
+   Example commit messages:
+   - `git commit -m "docs: add link to windsurf docs"`
+   - `git commit -m "fix: correct typo in README"`
+   - `git commit -m "build: add missing dependency"`
+
+5. Push to your fork:
+
+   ```bash
+   git push origin TYPE/description
+   ```
+
+6. Open a Pull Request from your fork to our main branch
+
+### Pull Request Requirements
+
+1. **PR Content**:
+   - Write a clear title and description explaining your changes
+   - Link to any related issues
+
+2. **Markdown Quality**: All markdown files must pass the markdownlint checks
+   - This is automatically checked by GitHub Actions
+   - It's also enforced by the pre-commit hook
+   - You can run checks manually using `npx markdownlint-cli2 "**/*.md"`
+
+3. **Changelog**: Changes are automatically tracked
+   - We use [auto-changelog](https://github.com/CookPete/auto-changelog) to generate our CHANGELOG.md
+   - The changelog is automatically generated from your commit messages
+   - You don't need to edit the CHANGELOG.md file manually
+   - For releases, add the 'release' label to your PR to create a version tag
+
+4. **Merge Conflicts**: Must be resolved before merging
+   - Keep your branch up to date with main
+   - If conflicts occur, merge main into your branch
+
 ## Contributing Prompts
 
 ### Directory Structure
@@ -50,20 +139,6 @@ prompts/
    - Document any assumptions or requirements
    - Avoid references to external files unless necessary
 
-## Pull Request Process
-
-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
-6. Push to your fork and submit a pull request
-
 ## Need Help?
 
 If you have questions or need help with your contribution:

README.md

@@ -1,12 +1,12 @@
 # [![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)
+[![GitHub Actions](https://github.com/ichoosetoaccept/awesome-windsurf/workflows/CI/badge.svg)](https://github.com/ichoosetoaccept/awesome-windsurf/actions)
 [![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)
 [![Maintained](https://img.shields.io/badge/Maintained-yes-58E5BB.svg)](https://github.com/ichoosetoaccept/awesome-windsurf/commits/main)
 [![Last Commit](https://img.shields.io/github/last-commit/ichoosetoaccept/awesome-windsurf?color=58E5BB)](https://github.com/ichoosetoaccept/awesome-windsurf/commits/main)
 [![GitHub repo size](https://img.shields.io/github/repo-size/ichoosetoaccept/awesome-windsurf?color=58E5BB)](https://github.com/ichoosetoaccept/awesome-windsurf)
-[![GitHub Actions Status](https://github.com/ichoosetoaccept/awesome-windsurf/workflows/CI/badge.svg)](https://github.com/ichoosetoaccept/awesome-windsurf/actions)
 [![License: CC0-1.0](https://img.shields.io/badge/License-CC0_1.0-E55882.svg)](http://creativecommons.org/publicdomain/zero/1.0/)
 [![GitHub stars](https://img.shields.io/github/stars/ichoosetoaccept/awesome-windsurf?style=social)](https://github.com/ichoosetoaccept/awesome-windsurf/stargazers)
 

commitlint.config.js

@@ -1,28 +1,34 @@
+/**
+ * Commitlint configuration for documentation repository
+ * 
+ * Commit Message Format:
+ * <type>: <description>
+ * 
+ * Types:
+ * - add: Add new documentation
+ * - update: Update existing documentation
+ * - remove: Remove documentation
+ * - fix: Fix typos, formatting, or broken links
+ * - meta: Changes to the repository itself (CI, scripts, etc)
+ * 
+ * Examples:
+ * - add: create guide for windsurf setup
+ * - update: improve clarity of installation steps
+ * - remove: outdated tutorial section
+ * - fix: correct typos in README
+ * - meta: update markdown linting rules
+ */
 module.exports = {
-  extends: ['@commitlint/config-conventional'],
   rules: {
     'type-enum': [
       2,
       'always',
-      [
-        'feat',    // New feature
-        'fix',     // Bug fix
-        'docs',    // Documentation only changes
-        'style',   // Changes that do not affect the meaning of the code
-        'refactor',// A code change that neither fixes a bug nor adds a feature
-        'perf',    // A code change that improves performance
-        'test',    // Adding missing tests or correcting existing tests
-        'build',   // Changes that affect the build system or external dependencies
-        'ci',      // Changes to our CI configuration files and scripts
-        'chore',   // Other changes that don't modify src or test files
-        'revert',  // Reverts a previous commit
-      ],
+      ['add', 'update', 'remove', 'fix', 'meta']
     ],
-    'type-case': [2, 'always', 'lower'],
+    'type-case': [2, 'always', 'lowerCase'],
     'type-empty': [2, 'never'],
-    'scope-case': [2, 'always', 'lower'],
     'subject-empty': [2, 'never'],
-    'subject-full-stop': [2, 'never', '.'],
-    'header-max-length': [2, 'always', 72],
-  },
-};
+    'subject-case': [2, 'always', 'lowerCase'],
+    'subject-full-stop': [2, 'never', '.']
+  }
+}

package.json

@@ -1,8 +1,11 @@
 {
+  "name": "awesome-windsurf",
+  "description": "A curated hub of awesome Windsurf resources",
   "version": "2024.12.2",
+  "private": false,
   "devDependencies": {
     "@commitlint/cli": "^19.6.0",
-    "@commitlint/config-conventional": "^19.6.0",
+    "@commitlint/config-conventional": "^19.0.0",
     "auto-changelog": "^2.5.0",
     "husky": "^9.1.7",
     "lint-staged": "^15.2.11",
@@ -14,5 +17,8 @@
   },
   "lint-staged": {
     "*.md": "markdownlint-cli2"
+  },
+  "commitlint": {
+    "extends": ["@commitlint/config-conventional"]
   }
 }