GitHub Issues
Use GitHub Issues to track work, discuss requirements, and capture decisions. Assume issues are public when repositories are public.
Best Practices
- Be clear and concise: Title should summarize the problem or feature in a few words
- Provide context: Include screenshots, steps to reproduce, or expected behavior
- Use labels and milestones: Help triage and planning
- Keep scope focused: One issue per feature/bug when possible
- Link related work: Reference PRs, commits, or related issues
- Use Teams when GitHub issues aren't needed: For quick questions, minor clarifications, or coordination that doesn't require tracking, communicate in the shared Teams team
Public Repository Caution
When repos are public, issues are visible to the world:
- Do not include sensitive data (PII, credentials, internal URLs, contract details, or security vulnerabilities)
- Avoid internal-only context (project codes, internal names, or procurement details)
- Use neutral language suitable for public readers
- If sensitive details are required, move the discussion to approved internal channels and summarize the outcome in the issue