Guidelines

This folder contains general developer guidelines for the Perma initiative. In a few cases they can be broken but such occurrences must be documented, ideally with code comments nearby.

Process Guidelines

Best practices and standards for project workflows:

  • review.md - Review conduct, constructive feedback principles, and review quality standards
  • issue-triage.md - Triage principles, clarity assessment criteria, and labeling best practices
  • issue-refinement.md - Refinement best practices, self-contained issue descriptions, and AI-assisted refinement
  • issue-reporting.md - Bug reporting standards, feature request standards, and required information
  • iteration-planning.md - Workload assessment principles, capacity planning, and balanced task assignment
  • tools.md - Tool documentation philosophy, self-documenting scripts, and directory organization

Technical Guidelines

Technical standards for development (see individual files for complete documentation).