mirror of
https://github.com/yakhyo/uniface.git
synced 2025-12-30 09:02:25 +00:00
docs: Update related docs and ruff formatting
This commit is contained in:
@@ -21,11 +21,28 @@ Thank you for considering contributing to UniFace! We welcome contributions of a
|
|||||||
|
|
||||||
### Code Style
|
### Code Style
|
||||||
|
|
||||||
|
This project uses [Ruff](https://docs.astral.sh/ruff/) for linting and formatting.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Check for linting errors
|
||||||
|
ruff check .
|
||||||
|
|
||||||
|
# Auto-fix linting errors
|
||||||
|
ruff check . --fix
|
||||||
|
|
||||||
|
# Format code
|
||||||
|
ruff format .
|
||||||
|
```
|
||||||
|
|
||||||
|
**Guidelines:**
|
||||||
- Follow PEP8 guidelines
|
- Follow PEP8 guidelines
|
||||||
- Use type hints (Python 3.10+)
|
- Use type hints (Python 3.10+)
|
||||||
- Write docstrings for public APIs
|
- Write docstrings for public APIs
|
||||||
|
- Line length: 120 characters
|
||||||
- Keep code simple and readable
|
- Keep code simple and readable
|
||||||
|
|
||||||
|
All PRs must pass `ruff check .` before merging.
|
||||||
|
|
||||||
## Development Setup
|
## Development Setup
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
|||||||
@@ -1,11 +1,15 @@
|
|||||||
# UniFace: All-in-One Face Analysis Library
|
# UniFace: All-in-One Face Analysis Library
|
||||||
|
|
||||||
|
<div align="center">
|
||||||
|
|
||||||
[](https://opensource.org/licenses/MIT)
|
[](https://opensource.org/licenses/MIT)
|
||||||
[](https://www.python.org/)
|
[](https://www.python.org/)
|
||||||
[](https://pypi.org/project/uniface/)
|
[](https://pypi.org/project/uniface/)
|
||||||
[](https://github.com/yakhyo/uniface/actions)
|
[](https://github.com/yakhyo/uniface/actions)
|
||||||
[](https://pepy.tech/project/uniface)
|
[](https://pepy.tech/project/uniface)
|
||||||
[](https://deepwiki.com/yakhyo/uniface)
|
[](https://deepwiki.com/yakhyo/uniface)
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
<div align="center">
|
<div align="center">
|
||||||
<img src=".github/logos/logo_web.webp" width=75%>
|
<img src=".github/logos/logo_web.webp" width=75%>
|
||||||
|
|||||||
@@ -205,4 +205,3 @@ Examples:
|
|||||||
|
|
||||||
if __name__ == '__main__':
|
if __name__ == '__main__':
|
||||||
main()
|
main()
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user