Back to all reviewers

Follow configuration best practices

microsoft/markitdown
Based on 2 comments
Other

Always adhere to official guidelines and proper validation when setting up configurations, whether for dependencies, file formats, or environment setup. This prevents subtle issues that can cause tests to pass incorrectly or create environment conflicts.

Configurations Other

Reviewer Prompt

Always adhere to official guidelines and proper validation when setting up configurations, whether for dependencies, file formats, or environment setup. This prevents subtle issues that can cause tests to pass incorrectly or create environment conflicts.

For dependency installation, use the recommended method from official documentation rather than generic approaches:

# Instead of:
install:
	pip install hatch

# Use the recommended approach:
install:
	pipx install hatch

For file configurations, validate that files have the correct format and MIME type, not just the right extension. A .doc file should have MIME type application/msword, not application/octet-stream. Simply renaming a .docx file to .doc doesn’t change its underlying format and can lead to false test results.

This practice ensures reliable, conflict-free environments and prevents configuration-related bugs from propagating through your system.

2
Comments Analyzed
Other
Primary Language
Configurations
Category

Source Discussions