Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix path handling on windows and add contribution section in README.md #59

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

emmanuel39hanks
Copy link
Contributor

@emmanuel39hanks emmanuel39hanks commented Jan 9, 2025

Type of change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

Description

The main fix addresses the Windows path validation issue where the scan endpoint was failing with "Invalid file path" errors. The validation logic has been updated to handle both backslash and forward slash formats, ensuring support for both Windows and Unix-style paths. Additionally, improvements were made to support absolute and relative path resolution.

Documentation updates include:

  • Detailed contribution guide with platform-specific examples.
  • Instructions for running the project on Windows and Unix platforms.
  • Example paths and workflows for development.

These changes improve platform compatibility and enhance developer guidance.

Related Issue

Issue Number: #42

Motivation and Context

This change was required to address path handling issues on Windows that caused errors when using the scan endpoint. Proper validation and documentation improvements ensure a consistent development and user experience across all platforms.

How Has This Been Tested?

The changes were tested by:

  • Verifying path validation with both absolute and relative paths on Windows and Unix systems.
  • Testing the scan endpoint to ensure it handles Windows-style paths correctly.

Screenshots (if appropriate):

Checklist

  • I have read the contributing guidelines
  • My code follows the code style of this project.
  • I have added tests that prove my fix is effective or that my feature works
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • Any dependent changes have been merged and published

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant