Skip to content

Feature request: Update README: branching, template repo, and team access guidance #2

@mejiaj

Description

@mejiaj

Summary

Our README doesn't explain three core workflows: branching strategy, how this template repo works, and how to add people to projects (via teams, not individually).

Describe the solution you'd like

Add a short, scannable section to the README that covers:

  1. Branching: naming conventions
  2. Template repo: when to use it, how to create a project from it, and other template repos
  3. Team access: best practices for adding users to GitHub teams

Alternatives you've considered

  • Create separate docs in /docs and link from README
  • Use an internal wiki page instead of README
  • Provide a minimal checklist with links to deeper docs

Additional context

  • Sample branch names (e.g., feature/bix-short-desc, fix/bix-55-issue)
  • Reference org-wide policies where relevant
  • Links to GitHub docs for template repos and team management

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions