@@ -32,7 +34,7 @@ Please refer to the [documentation](https://github.com/ModelTC/lightx2v/tree/mai
...
@@ -32,7 +34,7 @@ Please refer to the [documentation](https://github.com/ModelTC/lightx2v/tree/mai
## Contributing Guidelines
## Contributing Guidelines
We have prepared a `pre-commit` hook to enforce consistent code formatting across the project. If your code complies with the standards, you should not see any errors, you can clean up your code following the steps below:
We have prepared a `pre-commit` hook to enforce consistent code formatting across the project.
1. Install the required dependencies:
1. Install the required dependencies:
...
@@ -46,9 +48,9 @@ pip install ruff pre-commit
...
@@ -46,9 +48,9 @@ pip install ruff pre-commit
pre-commit run --all-files
pre-commit run --all-files
```
```
3. Finally, please double-check your code to ensure it complies with the following additional specifications as much as possible:
- Avoid hard-coding local paths: Make sure your submissions do not include hard-coded local paths, as these paths are specific to individual development environments and can cause compatibility issues. Use relative paths or configuration files instead.
- Clear error handling: Implement clear error-handling mechanisms in your code so that error messages can accurately indicate the location of the problem, possible causes, and suggested solutions, facilitating quick debugging.
- Detailed comments and documentation: Add comments to complex code sections and provide comprehensive documentation to explain the functionality of the code, input-output requirements, and potential error scenarios.
Thank you for your contributions!
Thank you for your contributions!
## Acknowledgments
We built the code for this repository by referencing the code repositories involved in all the models mentioned above.
