Skip to main content
Thanks for your interest in SimpleLLMFunc. Whether you want to fix bugs, improve documentation, add examples, or build new features, contributions are welcome.

​
Ways to Contribute

Before opening a new issue, search the GitHub Issues page to see whether someone has already reported the same problem or request.A good issue usually includes:
  1. a clear title
  2. background and problem statement
  3. reproduction steps and environment details
  4. code snippets, logs, or screenshots when helpful

​
Development Process

1

Prepare the environment

Make sure Python 3.12+ and Poetry are installed locally, then install dependencies.
2

Sync the latest code

Start from the latest upstream code before creating a branch, so you are not building on stale state.
3

Implement changes and add tests

Add or update tests and documentation for any user-facing behavior change.
4

Self-check before opening a PR

Confirm that tests pass, formatting is consistent, and the relevant docs have been updated.
If your change affects user workflows, configuration, or example code, update the corresponding documentation pages as part of the same pull request.

​
Development Environment Setup

​
Requirements

  • Python 3.12 or later
  • Poetry

​
Install development dependencies

git clone https://github.com/NiJingzhe/SimpleLLMFunc.git
cd SimpleLLMFunc
poetry install

​
Documentation i18n Workflow

Mintlify documentation internationalization is handled by script-driven locale page synchronization.
  • Chinese root pages remain the default source docs
  • Target language pages are generated under mintlify_docs/<lang>/...
  • Scripts can synchronize locale pages and navigation structure in batch
  • Missing content can be filled iteratively as translation content improves
poetry run python scripts/translate_mintlify_docs.py \
  --target-lang en

poetry run python scripts/translate_mintlify_docs.py \
  --target-lang en \
  --source-lang zh_CN \
  --sync-pages

poetry run python scripts/translate_mintlify_docs.py \
  --target-lang en \
  --source-lang zh_CN \
  --sync-pages \
  --translate

poetry run python scripts/translate_mintlify_docs.py \
  --target-lang en \
  --source-lang zh_CN \
  --write-docs-json
You can also use the batch helper: 
bash scripts/batch_translate_mintlify.sh
It is usually best to run an audit or a --sync-pages pass first so you can verify page structure, locale output, and navigation before refining translated wording.

​
Code Standards

Follow PEP 8 and prefer the style already established in the repository.
Add type annotations to new or modified public interfaces whenever practical.
  • Public APIs should have clear docstrings
  • Docstring style should stay consistent with the existing codebase
  • If a feature changes, update the relevant docs and examples as well

​
Code of Conduct

Please treat all contributors with respect. Harassment, discrimination, or abusive behavior is not acceptable.

​
Get Help

If you need help while contributing: Thanks again for contributing to SimpleLLMFunc.