How to Add a Contact Form to your GitHub README Without Exposing Your Email

GitHub READMEs are the perfect place to let visitors reach out—whether they’re collaborators, potential employers, or curious users. The usual approach is to drop a plain mailto: link, but that instantly broadcasts your address to spam bots, scrapers, and anyone who inspects the page source.

Enter FormCrab – a zero‑code, anti‑spam contact form that hides your email behind a private link. You get the messages straight to your inbox (or a webhook), while the address stays invisible to the web crawlers that love mailto:.

Below you’ll learn how to set it up, embed it in a GitHub README, and fine‑tune the experience with GET parameters. All without writing a single line of HTML or paying for hosting.


Why you should stop putting raw email on the web

Problem What happens when you use mailto:
Spam Bots harvest email addresses and flood you with junk.
Privacy Your address is exposed to anyone who can view source code.
Control You can’t customize the form, redirect, or pre‑fill fields.
Maintenance Changing the address requires editing every page you linked from.

FormCrab solves all of these with a single private endpoint you control.


What FormCrab gives you

  • Receive Messages, Hide Your Email – All submissions land in your inbox or webhook, never in the page source.
  • No code required – Just generate a link, paste it into your README.
  • Anti‑spam protection – Built‑in captcha‑free spam filtering.
  • Customizable GET parameters – Auto‑fill name, email, subject, message, or even change the post‑submission redirect.
  • One‑link, full control – Use the same link in GitHub READMEs, Twitter bios, static blogs, or anywhere else.

“Stop putting your raw email on websites. Get a private link, share it anywhere, and receive messages directly in your inbox.”formcrab.com


Step‑by‑Step: Adding a Contact Form to a GitHub README

1. Create your private link

  1. Go to formcrab.com and sign up.
  2. Click Create New Form.
  3. Choose where you want the submissions to go:
    • Email – receive a normal email notification.
    • Webhook – POST JSON to an endpoint you control.
  4. After saving, you’ll receive a URL that looks like:
https://formcrab.com/f/abcd1234efgh5678

Copy that URL; it’s your private token.

2. Insert the link into your README

GitHub Flavored Markdown supports ordinary markdown links. Use the private URL as the target:

[📬 Contact me] (https://formcrab.com/f/abcd1234efgh5678)

(Remove the space after the opening bracket – it’s added here only to avoid auto‑linking in this article.)

When a visitor clicks the link, FormCrab opens a clean, responsive contact form in a new tab.

3. Enhance the user experience with GET parameters

FormCrab lets you pre‑populate fields or control the redirect by adding query strings to the link. Replace {custom-link} with the token you received.

Goal Example (Markdown) What it does
Auto‑fill Name [Email us](https://formcrab.com/f/{custom-link}?name=Hugh) The Name field is already set to “Hugh”.
Pre‑set Visitor Email [Contact Support](https://formcrab.com/f/{custom-link}[email protected]) Email field shows [email protected].
Custom Subject [Report an Issue](https://formcrab.com/f/{custom-link}?subject=Urgent+Support+Request) Subject line appears as “Urgent Support Request”.
Predefined Message [Inquiry](https://formcrab.com/f/{custom-link}?message=I+would+like+to+request+a+demo) Message box contains the template text.
Custom Redirect [Send and Return](https://formcrab.com/f/{custom-link}?next=https://yoursite.com/success) After submitting, the user is taken to your custom “Thank You” page.

Tip: Combine parameters by separating them with &:

[Quick Demo Request](https://formcrab.com/f/{custom-link}?name=Alex&[email protected]&subject=Demo+Request&message=Please+show+me+the+product)

4. (Optional) Hook up a webhook

If you prefer programmatic handling, point FormCrab to a URL that accepts a POST request. The payload looks like this:

{
  "name": "Hugh",
  "email": "[email protected]",
  "subject": "hello! there",
  "message": "hello! there",
  "submittedAt": "2026-03-12 10:20:08",
  "extra": {
    "key1": "value1",
    "key2": "value2"
  }
}

Configure the webhook in your FormCrab dashboard, and you’ll receive JSON instantly for every submission—perfect for Slack alerts, CRM integrations, or custom analytics.

5. Test it live

  1. Click the link in your README (or open it directly in a browser).
  2. Fill out the form and submit.
  3. Verify that you receive the email/webhook.
  4. If you used a custom next redirect, confirm you land on the expected page.

6. Best practices for a professional look

Practice Why it matters
Use a clear call‑to‑action (e.g., “📬 Contact me”) Increases click‑through rates.
Keep the link in a separate line Avoids breaking the markdown layout.
Add a short description Gives context (“Feel free to ask me anything about this project”).
Rotate the token if compromised You can generate a new private link anytime from the dashboard.
Monitor spam metrics FormCrab’s dashboard shows spam‑filter performance.

Full Example: A Ready‑to‑Copy README Snippet

# My Awesome Open‑Source Project

...project description...

## Want to get in touch?

If you have questions, suggestions, or just want to say hi, feel free to reach out:

[📬 Contact the maintainer](https://formcrab.com/f/abcd1234efgh5678?subject=Project+Inquiry&next=https://github.com/yourname/yourrepo#thanks)

> After you submit, you’ll be redirected back to the “Thanks” anchor on this page.

That’s it—no HTML, no extra files, no server. Your email stays private, your visitors get a polished form, and you get the messages where you want them.


TL;DR

  • Stop using mailto: – it exposes your email to bots.
  • Create a private FormCrab link – one click, no code.
  • Paste the markdown link in your README – works everywhere GitHub renders markdown.
  • Optional: add GET parameters to auto‑fill fields or change the post‑submission redirect.
  • Optional: set a webhook for automated handling.

Ready to give your README a professional, spam‑free contact option? Head over to formcrab.com, generate your private link, and start collecting messages safely today.

Happy coding! 🚀

Ready to build your own forms?

Start receiving submissions today without worrying about email exposure or complex backends.

Create Your Private Link
Back to all articles