Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
173 lines (122 loc) · 3.5 KB

CONTRIBUTING.md

File metadata and controls

173 lines (122 loc) · 3.5 KB

Contributing to Text Humanizer

English | 中文

English

Project Status

This is a personal project currently maintained by PerryLink. While contributions are welcome, please note that this project is primarily developed and maintained by a single developer.

Reporting Issues

If you encounter any bugs or have feature requests, please open an issue on GitHub:

  1. Check if the issue already exists
  2. Provide a clear description of the problem or feature
  3. Include steps to reproduce (for bugs)
  4. Add relevant code snippets or error messages

Development Setup

  1. Clone the repository:
git clone https://github.com/PerryLink/text-humanizer.git
cd text-humanizer
  1. Install Poetry (if not already installed):
curl -sSL https://install.python-poetry.org | python3 -
  1. Install dependencies:
poetry install
  1. Run tests:
poetry run pytest

Code Style

This project follows PEP 8 guidelines:

  • Use Black for code formatting (line length: 88)
  • Write docstrings for all public functions and classes
  • Add type hints where appropriate
  • Keep functions focused and concise

Format your code before committing:

poetry run black src/ tests/

Pull Request Process

  1. Fork the repository
  2. Create a new branch for your feature or bugfix:
git checkout -b feature/your-feature-name
  1. Make your changes and ensure tests pass:
poetry run pytest
  1. Format your code:
poetry run black src/ tests/
  1. Commit your changes with a clear message:
git commit -m "Add feature: description of your changes"

  1. Push to your fork and submit a pull request

  2. Wait for review and address any feedback

Questions?

Feel free to open an issue for any questions or concerns. You can also reach out to the maintainer at novelnexusai@outlook.com.

中文

项目状态

这是一个由 PerryLink 个人维护的项目。虽然欢迎贡献,但请注意该项目主要由单个开发者开发和维护。

报告问题

如果你遇到任何 bug 或有功能请求,请在 GitHub 上提交 issue:

  1. 检查问题是否已存在
  2. 提供清晰的问题或功能描述
  3. 包含重现步骤(针对 bug)
  4. 添加相关代码片段或错误信息

开发环境搭建

  1. 克隆仓库:
git clone https://github.com/PerryLink/text-humanizer.git
cd text-humanizer
  1. 安装 Poetry(如果尚未安装):
curl -sSL https://install.python-poetry.org | python3 -
  1. 安装依赖:
poetry install
  1. 运行测试:
poetry run pytest

代码规范

本项目遵循 PEP 8 规范:

  • 使用 Black 进行代码格式化(行长度: 88)
  • 为所有公共函数和类编写文档字符串
  • 在适当的地方添加类型提示
  • 保持函数专注和简洁

提交前格式化代码:

poetry run black src/ tests/

Pull Request 流程

  1. Fork 仓库
  2. 为你的功能或 bug 修复创建新分支:
git checkout -b feature/your-feature-name
  1. 进行更改并确保测试通过:
poetry run pytest
  1. 格式化代码:
poetry run black src/ tests/
  1. 使用清晰的消息提交更改:
git commit -m "Add feature: description of your changes"

  1. 推送到你的 fork 并提交 pull request

  2. 等待审查并处理任何反馈

有问题?

欢迎为任何问题或疑虑提交 issue。你也可以通过 novelnexusai@outlook.com 联系维护者。