Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
77 lines (48 loc) · 1.38 KB

CONTRIBUTING.md

File metadata and controls

77 lines (48 loc) · 1.38 KB
Raw

How to contribute to Awex

Finding good first issues

See Good First Issues.

How to create an issue

Create an issue with this form.

How to title your PR

Generally we follows the Conventional Commits for pull request titles, since we will squash and merge the PR and use the PR title as the first line of commit message.

For example, here are good PR titles:

  • feat: support xxx feature
  • fix: blablabla
  • chore: remove useless yyy file
  • docs: add api doc for xxx method

For more details, please check pr-lint.yml.

Testing

For environmental requirements, please check DEVELOPMENT.md.

Python

Install test dependencies:

pip install -e ".[dev]"

Run tests:

pytest -v -s .

Code Style

Run all checks: bash ci/format.sh --all.

License headers

docker run --rm -v $(pwd):/github/workspace ghcr.io/korandoru/hawkeye-native:v3 format

Python

Install formatting tools:

pip install ruff

Format Python code:

ruff format .
ruff check --fix .

Markdown

npm install -g prettier
prettier --write "**/*.md"

Development

For more information, please refer to Development Guide.