Pull Request Guide

​

Before You Start

1. Set up your development environment
2. Read our code style guide
3. Reviewed existing issues and PRs

​

Creating a Pull Request

git clone https://github.com/YOUR_USERNAME/gaia.git
cd gaia

git remote add upstream https://github.com/theexperiencecompany/gaia.git

git checkout -b feature/your-feature-name

mise lint
mise test

git add .
git commit -m "feat(scope): description of changes"

git fetch upstream
git rebase upstream/master

git push origin feature/your-feature-name

​

Pull Request Guidelines

​

Title Format

feat(auth): add OAuth2 support
fix(api): resolve race condition in user creation
docs(readme): update installation instructions

​

Description Template

1. What: Brief description of the change
2. Why: Reason for the change
3. How: Technical approach taken
4. Testing: How you tested the changes
5. Screenshots: If applicable (for UI changes)
6. Related Issues: Link related issues

​

Checklist

• Code follows style guidelines
• Self-review completed
• Comments added for complex logic
• Documentation updated if needed
• No new warnings generated
• Tests added/updated and passing
• Dependent changes merged
• Conventional commit format used

​

Review Process

​

What to Expect

1. Automated Checks: CI/CD runs tests and linters
2. Code Review: Maintainers review your code
3. Feedback: Address any requested changes
4. Approval: Once approved, your PR will be merged

​

Responding to Feedback

• Be responsive to review comments
• Ask questions if feedback is unclear
• Make requested changes promptly
• Re-request review after updates

​

Making Changes

# Make your changes
git add .
git commit -m "fix: address review feedback"
git push origin feature/your-feature-name

​

After Merge

1. Delete your feature branch:
   git branch -d feature/your-feature-name
   git push origin --delete feature/your-feature-name
   
2. Update your local master:
   git checkout master
   git pull upstream master
   
3. You’ll be added to our contributors list! 🎉

​

Common Issues

git fetch upstream
git rebase upstream/master
# Resolve conflicts
git rebase --continue
git push origin feature/your-feature-name --force

mise lint:fix
mise test
git add .
git commit -m "fix: resolve CI issues"
git push

git fetch upstream
git rebase upstream/master
git push origin feature/your-feature-name --force

​

Getting Help

• Discord: Join our community
• Discussions: GitHub Discussions
• Issues: Comment on related issues