Contributing to Rhesis

git clone https://github.com/your-username/rhesis.git
cd rhesis

# Install Python dependencies
uv sync

# Install Node.js dependencies
cd apps/frontend && npm install
cd ../docs && npm install

cp .env.example .env
# Edit .env with your local configuration

./rh backend start
./rh frontend start
./rh docs start

# Create a new feature branch
git checkout -b feature/your-feature-name

# Or for bug fixes
git checkout -b fix/your-bug-description

# Or for documentation
git checkout -b docs/your-doc-update

# Format: type(scope): description
git commit -m "feat(backend): add user authentication endpoint"
git commit -m "fix(frontend): resolve login form validation issue"
git commit -m "docs(readme): update installation instructions"

# Use type hints
def create_user(user_data: UserCreate, db: Session) -> User:
    """Create a new user in the database."""
    user = User(**user_data.dict())
    db.add(user)
    db.commit()
    db.refresh(user)
    return user

# Use async/await for I/O operations
async def get_user_by_id(user_id: int, db: AsyncSession) -> Optional[User]:
    """Retrieve a user by ID."""
    result = await db.execute(
        select(User).where(User.id == user_id)
    )
    return result.scalar_one_or_none()

// Use TypeScript interfaces
interface User {
id: string;
email: string;
name: string;
organizationId: string;
}

// Use React hooks properly
const useUser = (userId: string) => {
return useQuery({
    queryKey: ["user", userId],
    queryFn: () => api.getUser(userId),
    enabled: !!userId,
});
};

// Use proper error handling
const handleSubmit = async (data: FormData) => {
try {
    await api.createUser(data);
    toast.success("User created successfully");
} catch (error) {
    toast.error("Failed to create user");
    console.error(error);
}
};

# Test example
def test_create_user(db_session):
    """Test user creation."""
    user_data = UserCreate(
        email="test@example.com",
        password="securepassword",
        name="Test User"
    )

    user = create_user(user_data, db_session)

    assert user.email == "test@example.com"
    assert user.name == "Test User"
    assert user.id is not None

// Component test example
import { render, screen, fireEvent } from '@testing-library/react';
import { UserForm } from './UserForm';

describe('UserForm', () => {
it('submits form data correctly', async () => {
    const mockSubmit = jest.fn();
    render(<UserForm onSubmit={mockSubmit} />);

    fireEvent.change(screen.getByLabelText('Email'), {
      target: { value: 'test@example.com' },
    });

    fireEvent.click(screen.getByText('Submit'));

    expect(mockSubmit).toHaveBeenCalledWith({
      email: 'test@example.com',
    });
});
});

class UserService:
    """Service for user management operations."""

    def __init__(self, db: Session):
        """Initialize the service with a database session."""
        self.db = db

    def create_user(self, user_data: UserCreate) -> User:
        """
        Create a new user in the system.

        Args:
            user_data: User creation data

        Returns:
            The created user object

        Raises:
            UserAlreadyExistsError: If user with email already exists
        """
        # Implementation...

@router.post("/users/", response_model=User)
async def create_user(
    user_data: UserCreate,
    current_user: User = Depends(get_current_user),
    db: Session = Depends(get_db)
):
    """
    Create a new user.

    This endpoint allows administrators to create new user accounts
    in the system.
    """
    return user_service.create_user(user_data, db)

## Description

Brief description of the changes made.

## Type of Change

- [ ] Bug fix
- [ ] New feature
- [ ] Documentation update
- [ ] Refactoring
- [ ] Test improvement

## Testing

- [ ] Unit tests pass
- [ ] Integration tests pass
- [ ] Manual testing completed

## Checklist

- [ ] Code follows style guidelines
- [ ] Documentation updated
- [ ] Tests added/updated
- [ ] No breaking changes

# Good review comment

Consider using a more descriptive variable name here.
`user_data` could be `user_creation_payload` to be more specific.

# Bad review comment

This is wrong.