​
Understanding linked issues

A linked issue is one that is explicitly referenced in your pull request description using platform-specific syntax: 
fixes #123
closes #123  
resolves #123
When CodeRabbit detects linked issues, it analyzes them against your pull request changes to determine if the requirements are met:
Linked Issue Assessment Example

​
Best practices for issue writing

​
Issue titles

Create descriptive, technical titles that clearly state the goal:
  • “Add PrismaLint integration to configuration flow”
  • “Fix race condition in user authentication”
  • “Implement caching for GraphQL queries”

​
Issue descriptions

Write comprehensive descriptions that provide clear technical context:
1

Problem statement

  • Clearly describe what needs to be changed
  • Include technical details about affected components
  • Reference specific files or functions if known
2

Expected solution

  • Outline the desired implementation approach
  • Include code examples or pseudo-code when relevant
  • List specific acceptance criteria
Example description: 
Problem:
The configuration system doesn't validate Prisma schema files before deployment, 
leading to potential runtime errors.

Solution:
Integrate PrismaLint into the configuration flow to:
- Validate schema files during PR checks
- Enforce consistent naming conventions
- Prevent common Prisma anti-patterns

Affected Components:
- Configuration validation pipeline
- CI/CD workflow  
- Schema validation logic

Acceptance Criteria:
- [ ] PrismaLint runs on all PR checks
- [ ] Failed validations block merging
- [ ] Clear error messages for schema issues

​
Consistent terminology

Use consistent terminology between issues and pull requests:
  • Use the same technical terms consistently
  • Reference components with their exact names
  • Maintain consistent naming patterns

​
Linking issues effectively

​
In pull requests

Fixes #123
Resolves organization/repo#456
Closes https://github.com/org/repo/issues/789

​
Cross-references

For better traceability:
1

Add PR references in issue comments

Link back to the pull request from the issue discussion
2

Use complete URLs for external systems

Include full URLs when referencing Jira, Linear, or other platforms
3

Maintain bidirectional links

Ensure related issues reference each other for complete context

​
How CodeRabbit assesses linked issues

CodeRabbit evaluates linked issues through this process:
1

Analyze issue content

Reviews issue titles and descriptions for requirements and context
2

Compare PR changes

Examines the code changes in the pull request
3

Validate requirements

Determines if the changes meet the stated objectives
4

Provide assessment

Returns one of three possible outcomes:
  • ✅ Addressed: Objective completed (no explanation needed)
  • ❌ Not addressed: Objective not met (explanation provided)
  • ❓ Unclear: Uncertain if objective is met (explanation provided)
Only the issue title and description are considered in the assessment. Comments and discussion threads are not currently analyzed.

​
Tips for better assessments

Be specific

  • Include clear, measurable objectives
  • List specific technical requirements
  • Reference affected code components

Provide context

  • Explain why changes are needed
  • Document current behavior
  • Describe expected outcomes

Use technical details

  • Include file paths when known
  • Reference specific functions or classes
  • Mention relevant technologies

Keep it focused

  • One main objective per issue
  • Clear scope boundaries
  • Specific acceptance criteria

Review instructions

Learn how to add custom instructions to your reviews

Issue chat

Chat directly with CodeRabbit about issues

Issue creation

Automatically create issues from PR reviews