Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
56 lines (39 loc) · 1.19 KB

CONTRIBUTING.md

File metadata and controls

56 lines (39 loc) · 1.19 KB

Contributing

Thanks for your interest in improving Fact Classification System.

Development Workflow

  1. Fork the repository.
  2. Create a feature branch from main.
  3. Make focused changes.
  4. Add or update tests.
  5. Open a pull request.

Setup

git clone https://github.com/levvius/Fact-Classification-System.git
cd Fact-Classification-System
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
python scripts/build_kb.py

Before Opening a Pull Request

Run checks locally:

pytest tests/unit -m unit

If your change affects pipeline behavior, also run:

pytest tests/integration -m integration

Pull Request Guidelines

  • Keep PRs small and single-purpose.
  • Explain why the change is needed.
  • Include test coverage for behavior changes.
  • Update docs when APIs, config, or workflows change.

Commit Message Style

Use concise, imperative messages, for example:

  • update README and add GitHub community files
  • fix timeout handling in classify endpoint
  • add integration test for mixed claims

Reporting Issues

  • Use the issue templates in GitHub.
  • For security problems, follow SECURITY.md instead of filing a public issue.