Files

T

ViperEkura 10fec8dca1 docs: fix stale docs and align with code

- update cuda_kernels layout, arch flags, and add FP8 section
- fix install docs: kernels auto-build when nvcc + CUDA detected
- mark ignored OpenAI request params and complete KVCache fields
- add docker docs to indexes and astrai.optim to module overview
- refresh document update timestamps

2026-08-23 14:23:28 +08:00

2.7 KiB

Raw Blame History

Contributing to AstrAI

Thank you for your interest in contributing! This document provides step-by-step guidelines.

Quick Start

git clone https://github.com/ViperEkura/AstrAI.git
cd AstrAI
pip install -e ".[dev]"     # install with dev dependencies (pytest, ruff)

Before You Commit

Run the following checks in order — CI will reject if any fail.

1. Format

ruff format .

2. Import sorting

ruff check . --select I

If this fails, manually fix import ordering (ruff does not auto-fix in this project's CI):

ruff check . --select I --fix .
ruff format .    # re-format after fix

3. Run tests

python -u -m pytest tests/ -v

Failed tests may leave orphan tempdirs under the system temp directory ($TMPDIR on Linux/macOS, %TEMP% on Windows). Clean them manually if needed.

4. (Optional) Full pre-commit check script

If you have bash available (Git Bash on Windows works too):

bash scripts/pre_commit.sh

The script installs development dependencies by default, then runs the format check, import sort check, and tests. If dependencies are already installed, use:

bash scripts/pre_commit.sh --skip-deps

Commit Style

type: short description (~50 chars)

- bullet point body (each ~60 chars)

Type must be one of: fix, feat, chore, docs, refactor, perf, test, style, ci, build, revert.
Subject line ends with no period.
Body uses bullet points starting with -.
No (scope) parentheses.

Common Issues

Problem	Cause	Fix
`ruff check --select I` fails	Wrong import order	`ruff check . --select I --fix .` then `ruff format .`
`ruff format` changed many files	Not formatted before commit	Review diff carefully before staging
Pre-commit check script fails	Dependency install, tests, or lint failed	Fix the failing step; use `--skip-deps` only when dependencies are already installed
Tests fail with tempdir left	Test crash	Clean `%TEMP%` manually

Submitting Changes

Fork the repo.
Create a feature branch: git checkout -b feat/my-feature
Make changes following the steps above.
Commit with the commit style above.
Push: git push origin feat/my-feature
Open a Pull Request against main.

Code Review

All PRs are reviewed. We may request changes.
CI runs ruff format --check . then ruff check . --select I (no --fix in CI).
Ensure all tests pass.

License

By contributing, you agree that your contributions will be licensed under the Apache-2.0 License.

Questions? Ask in GitHub Discussions or open an issue.

2.7 KiB Raw Blame History