GitHub Workflow
GitHub-centric workflow for repositories, PRs, issues, and collaboration
Our workflow is built entirely on GitHub. This page covers how we use repositories, branching, pull requests, and related features.
Repositories and Branching
- Main branch: Protected; changes go through pull requests.
- Feature branches: Create branches from
mainfor new work. Use descriptive names, e.g.feature/add-interns-docsorfix/login-validation. - Keep branches short-lived: Merge or close within a few days to avoid drift.
Pull Requests and Code Review
Create a branch
Branch from main and make your changes.
Open a pull request
Link to related issues, add a clear description, and request review.
Address feedback
Respond to comments and push updates. Re-request review when ready.
Merge
Once approved, squash or merge according to repo conventions.
Issues and Projects
- Issues: Use for bugs, features, and tasks. Add labels, assignees, and milestones.
- Projects: Boards and tables organize work. Link issues to projects for visibility.
- Discussions: Use for questions, ideas, and decisions that don't fit a single issue.
Best Practices for Intern Contributions
Tips for Interns
- Start with small, well-scoped PRs.
- Read existing code and docs before changing them.
- Ask questions in PR comments or Discussions.
- Use AI to help understand code, but always verify and test.
GitHub Actions and Automation
Many repos use GitHub Actions for CI/CD. When you open a PR, checks may run automatically. Ensure your changes pass before requesting review.
GitHub Copilot and Codespaces
- Copilot: Use for code suggestions, tests, and documentation. Review suggestions before accepting.
- Codespaces: Cloud development environments. Useful when local setup is complex or you need a consistent environment.