Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
47 lines (32 loc) · 1.37 KB

CONTRIBUTING.md

File metadata and controls

47 lines (32 loc) · 1.37 KB

中文版

FlagTree Contributor Guide

Thank you for your interest in FlagTree! We use GitHub to host code, manage issues, and handle pull requests. Before contributing, please read the following guidelines.

Bug Reports

Please use GitHub Issues to report bugs. When reporting a bug, include:

  • A concise summary
  • Steps to reproduce
  • Specific and accurate descriptions
  • Example code if possible (this is particularly helpful)

Code Contributions

When submitting a pull request, contributors should describe the changes made and the rationale behind them. If possible, provide corresponding tests and add them to .github/workflow/. Pull requests require approval from at least ONE team member before merging and must pass all continuous integration checks. The best Pull Request has 1,000 review comments, discussions, and revisions; the next one has 100.

Code Formatting

We use pre-commit for code formatting checks:

python3 -m pip install pre-commit
cd ${YOUR_CODE_DIR}/FlagTree
pre-commit install
pre-commit

Unit Tests

After installation, you can run unit tests in the backend directory:

cd third_party/backendxxx/python/test/unit
python3 -m pytest -s

Backend Integration

Please contact the core development team for backend integration matters.

License

FlagTree is licensed under the MIT license.