Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
35 lines (25 loc) · 1.66 KB

CONTRIBUTING.md

File metadata and controls

35 lines (25 loc) · 1.66 KB
Raw

Contributing to ARTEMIS

Thank you for your interest in contributing to ARTEMIS! We welcome and appreciate all forms of contributions—whether it's reporting bugs, proposing new features, improving documentation, or submitting code.

🤝 Ways to Contribute

  • 🐛 Report Bugs & Suggest Features: If you find an issue or have an idea to improve ARTEMIS, please open an Issue.
  • 💡 Submit Pull Requests:
    1. Fork the repository and create your feature/fix branch (git checkout -b feat/my-feature).
    2. Make your changes and verify with make test, make lint, and make typecheck.
    3. Open a Pull Request with a brief summary of your work.
  • 💬 Community & Discussion: Join our Discord Community to chat with maintainers, ask questions, or share feedback.

Every contribution—big or small—helps make ARTEMIS better. Thank you for building with us!

Test layers

make test is the required, deterministic suite. It does not need an Android device, model credentials, or the optional private cloud service. This is the same suite used by pull-request CI.

  • make test-integration runs cross-component tests that may need configured model credentials.
  • make test-device runs Android and end-to-end tests and therefore requires an attached, authorized device or emulator.
  • make test-all collects every test tree and is intended for a fully provisioned maintainer environment.

Tests that require external state must carry the appropriate android, cloud, manual, or e2e marker. They must remain safely collectable when that dependency is unavailable.