Skip to content

Adherence to Coding Standards

Prompt 1: Reviewing Code for Standards

Use Case: To guide developers in reviewing code for adherence to coding standards.

Prompt: You are reviewing a pull request for a new feature. The code details are as follows:

Code_snippet: {code_snippet}

Generate feedback on the code, ensuring:
- Proper naming conventions.
- Consistent indentation and formatting.
- Use of comments for clarity.

Key points:
1. Focus on adherence to project-specific coding standards.
2. Provide actionable feedback for improvement.
3. Use examples to illustrate best practices.

or give reference to the project's coding standards document #coding standards.md