Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
53 lines (34 loc) · 1.82 KB

CONTRIBUTING.md

File metadata and controls

53 lines (34 loc) · 1.82 KB
Raw

Contributing

Reporting Bugs/Feature Requests

We welcome you to use the GitHub issue tracker to report bugs or suggest features.

When filing an issue, please check existing open or recently closed issues to make sure somebody else hasn't already reported the issue.

Contributing via Pull Requests

  1. Work against the latest master branch.
  2. Check existing issues and PRs to avoid duplicate work.
  3. Open an issue to discuss any significant work before starting.

Setup

  1. Install the package in development mode:
pip install -e ".[tests]"
  1. Install pre-commit hooks:
pip install pre-commit
pre-commit install

This will run ruff formatting and linting automatically on each commit.

Running Tests

pytest tests/

To run a specific test:

pytest tests/path_to_file.py::test_name

Note: most tests require AWS credentials and will launch SageMaker jobs. The CI will not run automatically for external contributors — ping a maintainer to tag your PR with safe to test.

Security Issue Notifications

If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our vulnerability reporting page. Please do not create a public GitHub issue.

Code of Conduct

This project has adopted the Amazon Open Source Code of Conduct. For more information see the Code of Conduct FAQ.

Licensing

See the LICENSE file for our project's licensing. We will ask you to confirm the licensing of your contribution.