How to add a booking link to your GitHub profile README
On this page
How do you add a booking link to a GitHub profile README?
Edit your existing profile README and insert a descriptive Markdown link to the public appointment page. If you haven't created a profile repository, make a public repository named exactly like your username with a README in its root.
Check for it first. Creating a second unrelated repository won't replace a profile README that already exists under the matching username.
The GitHub profile README instructions, as of 17 November 2026, give this creation sequence:
- Select + > New repository.
- Name the repository exactly like your username.
- Choose Public.
- Turn on Add README.
- Select Create repository.
Then edit the file and save your appointment invitation. A booking page is the destination for choosing a time; the README supplies the context a contributor needs before opening it.
We support public event URLs in Barq Meet, so the link can point directly to a contributor conversation instead of a general page with several unrelated appointments.
What Markdown should the GitHub appointment link use?
Use a descriptive text link with the purpose and duration close by. A badge is optional; plain Markdown makes the destination understandable without requiring an image generator, a logo or a separate asset host.
Keep it readable. The invitation should tell contributors when live discussion helps, so office hours don't silently become the default route for every bug report. For colleague office hours, add the scheduling destination to Slack with an urgent-support route kept separate. For a project already under discussion, add the appointment to a proposal or document beside the decision it should help reach.
## Contributor office hours
For [conversation purpose], reserve a [duration]-minute conversation.
Please include [issue or discussion context] when booking.
[Reserve contributor office hours]([Public booking URL])Replace the variables, including the entire bracketed URL placeholder. Use a real HTTPS destination and inspect the rendered result before saving the placement as finished.
For a Calendly link in a GitHub profile README, substitute the public appointment address. The Markdown placement doesn't establish a GitHub integration or automatic issue-data transfer.
We let you add custom questions to Barq Meet booking forms. A short request for an issue or discussion reference can provide context without pretending the booking app has read the repository.
Why isn't the appointment README showing on your profile?
Check that the repository name matches your username, the repository is public and a non-empty README.md sits in its root. GitHub documents all four conditions; a correct booking link inside the wrong repository won't create the profile section.
Inspect the repository itself. A README in a subdirectory doesn't satisfy the root-file requirement stated in the checked documentation.
The requirements come from GitHub's profile README guide, as of 17 November 2026.
| Requirement | What to verify |
|---|---|
| Matching repository name | Same as your username |
| Public visibility | Repository is public |
| Root file | README.md is at the top level |
| File content | README isn't empty |
Our permitted research doesn't verify the separate Website field in GitHub's Public profile settings, so this tutorial uses the documented README route instead.
GitHub also documents up to four social-account links in its profile personalization tutorial, as of 17 November 2026. That isn't evidence that every booking destination qualifies as a social-account URL.
How should maintainers offer office hours without promising constant support?
Define the conversation and the time you're willing to reserve before publishing the URL. A public profile can invite project discussions, but it shouldn't imply unlimited availability or replace the repository's normal support process.
Keep ordinary issues in writing. A short live conversation can help with a bounded design decision once the relevant context is available for both participants to read.
For a suggested setup, offer a 25-minute discussion with a 5-minute buffer afterwards. Two appointments require 2 × 30 = 60 minutes of availability, including the buffers.
We apply the event's buffers and selected Google-calendar conflicts when offering appointments in Barq Meet. We recheck the time at confirmation, so a slot that became occupied while a contributor was reading can't be reserved as though it remained free.
The host must use Google Calendar. We don't connect iCloud or Outlook calendars, and sharing the link in a GitHub README doesn't add either connection. For professional introductions, add the appointment to LinkedIn using the controls available to the account you actually have.
How do you test the GitHub office-hours invitation?
Open the rendered public profile, follow the Markdown link and complete a deliberate test reservation. Compare the meeting description, selected length and calendar invitation with the README wording before directing contributors to use it.
Check outside the editor. A Markdown preview can look correct while the destination still contains an unreplaced placeholder or points at a host-only page. For visitors finding you on X, put a clear booking destination in the profile and check it while signed out. The Business Profile booking guide checks that customers reach the named offer instead of a general profile or a video room.
| Problem | Inspect | Fix |
|---|---|---|
| Profile section missing | README display requirements | Correct the repository or file |
| Link displays incorrectly | Markdown brackets and URL | Replace placeholders and preview |
| Wrong host or event opens | Public appointment destination | Copy the intended event URL |
| No source identified | Tracking values | Add placement tags and test again |
Use source labels for GitHub office-hours appointments to identify that route. Compare other places to share your availability link, check the scheduling account's features, then prepare contributor office hours for your profile.
Steps
Check for an existing profile README
Look for the public repository whose name matches your GitHub username. If it already contains a profile README, edit that file instead of creating another repository.
Create the profile repository if needed
Use plus and New repository, name it exactly like your username and choose Public. Turn on Add README and create the repository.
Add a descriptive Markdown link
Edit the root README.md and write an appointment link with a purpose and duration. Replace the sample destination with your public booking URL.
Save the README with visible content
Keep README.md in the repository root and save the change. The repository must remain public and the file must contain content to display on your profile.
Test the rendered public profile
Open your profile as a visitor and follow the appointment link. Verify its host and purpose before completing and canceling a test booking.
Frequently asked questions
Can a private repository supply the profile README?
GitHub's checked requirements call for a public repository whose name matches your username, with a non-empty README.md in its root. A private repository doesn't meet that profile-display requirement (GitHub README docs, as of 17 November 2026). Check the documented profile README requirements before relying on the repository as a place for visitors to discover your appointment offer.
Do I need a badge image to link the appointment?
No. A descriptive Markdown text link gives the reader a destination without an image service. If you choose to add a badge later, keep the purpose understandable and test what the profile displays when the image doesn't load. Use readable linked text that names the conversation; a badge image isn't needed to make the appointment destination understandable or usable.
Should every support issue use the booking link?
No. Keep routine questions in the project's normal issue or discussion process. Reserve office hours for a defined conversation that benefits from live discussion, and explain what context a contributor should provide before booking. Keep routine bug reports in the issue process and offer a call when a discussion with the named maintainer would actually help resolve the problem.
Related pages
- Where to share your booking link: 25 places that work
Choose among 25 booking link placements, including email, profiles, proposals and printed material. Start with intent and test each live destination.
- What is a booking link?
A booking link lets someone pick a time; a meeting link joins the call. Follow a 30-minute appointment from offered hours to confirmation.
- How to track where your bookings come from with UTM tags
Tag booking links with utm_source, utm_medium and utm_campaign. Test attribution in Insights and distinguish campaign labels from page, embed and API.
- How to add a booking link to your Slack profile
Check your Slack workspace's profile fields before adding a booking URL. Custom fields need an admin and must be edited on desktop.
- How to add a booking link to your X (Twitter) profile
Put a booking URL in the X Website field, keep the 160-character bio focused on the call and test the saved public profile on mobile.
- How to add a booking link to your LinkedIn profile
Add a booking URL to LinkedIn Contact info or Featured. Learn which Premium button eligibility is verified and how to test the visitor booking path.
Create your free booking link
Sign in with Google, create an event and share your link.
Create your free link