Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
59 lines (43 loc) · 1.57 KB

CONTRIBUTING.md

File metadata and controls

59 lines (43 loc) · 1.57 KB

Contributing to EvalCI

Thanks for your interest in contributing! EvalCI is a GitHub Action built on SynapseKit.

Ways to contribute

  • Report bugs via Issues
  • Request features via Issues
  • Start a discussion via Discussions
  • Submit a pull request (see below)

Development setup

git clone https://github.com/SynapseKit/evalci.git
cd evalci
pip install synapsekit[openai]

The Action has two files to work with:

  • action.yml — composite Action definition (inputs, outputs, steps)
  • entrypoint.py — pure stdlib Python runner (no extra deps)

Running the entrypoint locally

INPUT_PATH=. \
INPUT_THRESHOLD=0.7 \
INPUT_FAIL_ON_REGRESSION=false \
INPUT_GITHUB_TOKEN="" \
GITHUB_REF="refs/heads/main" \
GITHUB_REPOSITORY="owner/repo" \
python entrypoint.py

Running tests

python -m pytest tests/ -v
# or without pytest:
python tests/test_entrypoint.py

Submitting a PR

  1. Fork the repo and create a branch: git checkout -b fix/my-fix
  2. Make your changes
  3. Test locally (see above)
  4. Open a PR — the template will guide you

Guidelines

  • entrypoint.py must stay pure stdlib — no new dependencies
  • Keep action.yml inputs backwards-compatible
  • One concern per PR

License

By contributing, you agree your contributions are licensed under the Apache 2.0 License.