[PR #7265] [MERGED] docs: update upstream remote setup commands in contributing guide #7183

Closed
opened 2026-03-13 13:27:03 -05:00 by GiteaMirror · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/better-auth/better-auth/pull/7265
Author: @meetgoti07
Created: 1/11/2026
Status: Merged
Merged: 1/12/2026
Merged by: @himself65

Base: canaryHead: fix/contribution_docs


📝 Commits (2)

  • 027fdee docs: add missing upstream remote setup commands in contributing guide
  • 2b668ca Merge branch 'canary' into fix/contribution_docs

📊 Changes

1 file changed (+6 additions, -3 deletions)

View changed files

📝 docs/content/docs/reference/contributing.mdx (+6 -3)

📄 Description

Description

This PR updates the contributing guide to:

  1. Add the missing git remote add upstream command needed before pulling from upstream
  2. Update the default branch reference from main to canary

Changes

  • Added git remote add upstream https://github.com/better-auth/better-auth.git command
  • Updated branch references from main to canary in the git workflow commands
  • Updated comments to reflect the canary branch

Why

  1. Upstream remote setup: When contributors clone their fork and try to follow the contributing guide, they need to set up the upstream remote before they can pull from it. Without this command, git pull upstream canary would fail for new contributors.

  2. Branch update: The repository now uses canary as the default branch instead of main, so the contributing guide should reflect this change.

Testing

  • Verified the commands are in the correct order
  • Confirmed the workflow uses the correct branch name (canary)
  • Ensured the workflow makes sense for new contributors

Summary by cubic

Updated the contributing guide to add the missing upstream remote setup and switch branch references from main to canary. This prevents git pull failures for new contributors and aligns the docs with the current default branch.

Written for commit 2b668ca0bd. Summary will update on new commits.


🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/better-auth/better-auth/pull/7265 **Author:** [@meetgoti07](https://github.com/meetgoti07) **Created:** 1/11/2026 **Status:** ✅ Merged **Merged:** 1/12/2026 **Merged by:** [@himself65](https://github.com/himself65) **Base:** `canary` ← **Head:** `fix/contribution_docs` --- ### 📝 Commits (2) - [`027fdee`](https://github.com/better-auth/better-auth/commit/027fdee85e857511e87c506923c356321de6310d) docs: add missing upstream remote setup commands in contributing guide - [`2b668ca`](https://github.com/better-auth/better-auth/commit/2b668ca0bd1f490ca7f36b09d1fd0f3cc8011be0) Merge branch 'canary' into fix/contribution_docs ### 📊 Changes **1 file changed** (+6 additions, -3 deletions) <details> <summary>View changed files</summary> 📝 `docs/content/docs/reference/contributing.mdx` (+6 -3) </details> ### 📄 Description ## Description This PR updates the contributing guide to: 1. Add the missing `git remote add upstream` command needed before pulling from upstream 2. Update the default branch reference from `main` to `canary` ## Changes - Added `git remote add upstream https://github.com/better-auth/better-auth.git` command - Updated branch references from `main` to `canary` in the git workflow commands - Updated comments to reflect the canary branch ## Why 1. **Upstream remote setup**: When contributors clone their fork and try to follow the contributing guide, they need to set up the upstream remote before they can pull from it. Without this command, `git pull upstream canary` would fail for new contributors. 2. **Branch update**: The repository now uses `canary` as the default branch instead of `main`, so the contributing guide should reflect this change. ## Testing - [x] Verified the commands are in the correct order - [x] Confirmed the workflow uses the correct branch name (canary) - [x] Ensured the workflow makes sense for new contributors <!-- This is an auto-generated description by cubic. --> --- ## Summary by cubic Updated the contributing guide to add the missing upstream remote setup and switch branch references from main to canary. This prevents git pull failures for new contributors and aligns the docs with the current default branch. <sup>Written for commit 2b668ca0bd1f490ca7f36b09d1fd0f3cc8011be0. Summary will update on new commits.</sup> <!-- End of auto-generated description by cubic. --> --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
GiteaMirror added the pull-request label 2026-03-13 13:27:03 -05:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/better-auth#7183