Skip to content

Contributing to CXAS SCRAPI

First off, thank you for considering a contribution to CXAS SCRAPI. Whether you're fixing a typo, reporting a bug, or proposing a new feature, your help makes this project better for everyone.

How You Can Help

There are many ways to contribute, and not all of them involve writing code:

  • Report bugs — Found something that doesn't work as expected? Open an issue with steps to reproduce.
  • Suggest features — Have an idea that would make SCRAPI more useful? We'd love to hear it.
  • Improve documentation — Spotted a confusing explanation or missing example? Documentation PRs are always welcome.
  • Write code — Fix a bug, add a feature, or improve test coverage.

Getting Started

If you're new to contributing, here's the quickest path:

  1. Set up your development environment — Fork, clone, and install in editable mode.
  2. Review our code style — We use ruff for linting and follow Google-style docstrings.
  3. Submit a pull request — Our PR process is straightforward.

Community Guidelines

  • Be respectful and constructive in all interactions.
  • When reviewing code, focus on the code rather than the person.
  • If you disagree with a decision, explain your reasoning clearly — we're all here to build something great.

License

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