1.3 KiB
1.3 KiB
Review Prompt Extension
The Kodo tool supports the ability to extend the built-in prompt for review. This can be done in the following way
1. The CONSTITUTION.md file
You can create a .review folder if it does not exist and add a CONSTITUTION.md file to this folder, which will contain part of the prompt that will be read by the tool during execution.
my-project/
├── .review/ ← Create this folder
│ └── CONSTITUTION.md ← Your custom rules
├── src/
└── ...
The .review folder must be placed in the root of your repository.
1.1. Example of the CONSTITUTION.md file.
Example of a file you can create
# Additional rules for code reviews.
1. Do not check dependency declarations in code files
2. Do not check namespaces
# Knowledge about the project structure
This project contains the following modules:
1. DataEngine - the core for processing user data.
2. Viewer - a tool for visualizing user data.
1.2. Recommendations for the CONSTITUTION.md file
There are some recommendations for creating content for this file:
- Do not provide contradictory instructions and information.
- Provide a detailed description of any modules and rules.
- Do not make this file large, as it will be part of the prompt, which has a limited context.