Contribute

Share your knowledge, help the community

GitHub Logo github.com/surfdeeper/surfdeeper

Contributing Made Easy

Follow these simple steps to start contributing, even if you're new to coding!

1. Download VS Code

Visual Studio Code is a free code editor for Windows, Mac, and Linux.

2. Sign Up for GitHub

Create a free account to contribute and track your changes.

3. Set Up Copilot

In VS Code, go to Extensions and install GitHub Copilot. Sign in with your GitHub account.

4. Fork & Clone the Repo

Go to the repo and click Fork.
Then, copy your repo link and run:
git clone https://github.com/YOUR-USERNAME/surfdeeper.git

5. Add/Edit Guides & Spots

Edit or add Markdown files in src/content/guides/ or src/content/spots/. Copilot will help you write!

6. Commit & Push

In the terminal, run:
git add .
git commit -m "Add new guide/spot"
git push origin main

7. Make a Pull Request

Go to your fork on GitHub, click Compare & pull request, add a description, and submit!

Visit the Project Repo

Update Spot Coordinates

If you notice a spot's pin is in the wrong location on the map:

  1. Go to the Spots page
  2. Click on the spot marker to open the popup
  3. Click "📍 Pin in wrong location?"
  4. Drag the pin to the correct location
  5. Click "Done - Show Instructions" to get the new coordinates
  6. Follow the GitHub link to submit your correction

The coordinates are stored in the frontmatter of each spot's markdown file at src/content/spots/.

How it works

Keep it simple. Follow existing patterns. That’s it.

Schema lives in content config. Browse existing files in the guides folder and copy the closest example.

Quick steps

  1. Open the guides folder.
  2. Copy an existing file in the right section; rename with a clear slug.
  3. Edit the title and content; add order if you want to control position.
  4. Open a PR. We’ll review quickly.

PR workflow (short)

Use the GitHub UI for quick edits, or develop locally with npm run dev. Keep changes small and follow existing patterns. Link sources when helpful.