power-platform-github-copilot-kit: Instructions file for GitHub Copilot

Clean Code Instructions

This guidance summarizes essential clean code principles for HTML, JavaScript, TypeScript, and C# projects. Use it as a shared code quality baseline across projects.

Why clean code matters

• Clean code is easy to understand, review, and maintain.
• It reduces defects and makes changes safer.
• It keeps teams aligned around consistent naming, structure, and intent.

General rules

1. Follow standard conventions for the language and framework.
2. Keep it simple. Simpler solutions are easier to read and change.
3. Leave code cleaner than you found it.
4. Find and fix root causes, not just symptoms.

Design rules

1. Keep configurable data at high levels.
2. Prefer polymorphism or strategy patterns over long if/else or switch chains.
3. Keep concurrency and async control logic separate from business logic.
4. Avoid over-configurability and unnecessary indirection.
5. Use dependency injection where it improves testability and decoupling.
6. Follow the Law of Demeter: use only direct dependencies.

Understandability tips

1. Be consistent in style, naming, and structure.
2. Use explanatory variables and clear expressions.
3. Encapsulate boundary conditions and edge-case logic.
4. Prefer domain-specific value objects over raw primitives.
5. Avoid hidden dependencies between methods or modules.
6. Avoid negative conditionals when a positive form is clearer.

Names rules

1. Choose descriptive, unambiguous names.
2. Make meaningful distinctions between similar concepts.
3. Use pronounceable names.
4. Use searchable names that are easy to find in the codebase.
5. Replace magic numbers with named constants.
6. Avoid encoding type or prefix information in names.

Functions and methods

1. Keep functions small.
2. Do one thing per function.
3. Use descriptive names.
4. Prefer fewer arguments.
5. Avoid side effects whenever possible.
6. Don’t use flag arguments; split behavior into separate functions.

Comments

1. Prefer self-explanatory code to comments.
2. Don’t add redundant comments.
3. Avoid noisy comments that state the obvious.
4. Don’t use closing-brace comments.
5. Don’t leave commented-out code in the repository.
6. Use comments to explain intent, clarify decisions, or warn about consequences.