Guidelines

This folder contains general developer guidelines for the Perma initiative.

Guideline about Guidelines

• If needed guidelines can be broken but such occurrences must be documented, usually with code comments nearby.
• Guidelines generally don't need rationale, it is like with traffic lights: it does not matter if you go over it with green or red, as long as everyone does the same.

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).

Frontend CSS & Styling

• frontend-css.md - CSS units, Tailwind usage, CSS custom properties, CSS Modules, responsive design, dark mode, third-party library styling