Skip to content

Latest commit

 

History

History
57 lines (43 loc) · 2.47 KB

CONTRIBUTING.md

File metadata and controls

57 lines (43 loc) · 2.47 KB

Contributing to Magika

TL;DR

  • We review pull requests only for issues labeled help wanted and for the short always-welcome list in the contribution policy. For anything else, open a concise issue first.
  • Use whatever tools you like, AI included. You own every line you submit, you can explain it, and you are the one who talks to us.
  • Keep it short. One PR, one problem, a few lines of description. We read everything by hand.
  • Low-effort submissions are closed without discussion. Repeat offenders are blocked.
  • No claiming: the first good PR for an issue wins.

Full guidelines

The complete guidelines live on the website; the Markdown sources are in this repository under website-ng/src/content/docs/contributing/.

  • How to Contribute (the policy): website · source
  • Reporting Issues (misdetections, new content types, bugs, samples): website · source
  • Developer Guide (tests, knowledge base updates, detection rules, bindings): website · source
  • Security vulnerabilities: see SECURITY.md.

Before you begin

Sign our Contributor License Agreement

Contributions to this project must be accompanied by a Contributor License Agreement (CLA). You (or your employer) retain the copyright to your contribution; this simply gives us permission to use and redistribute your contributions as part of the project.

If you or your current employer have already signed the Google CLA (even if it was for a different project), you probably don't need to do it again.

Visit https://cla.developers.google.com/ to see your current agreements or to sign a new one.

Review our Community Guidelines

This project follows Google's Open Source Community Guidelines.

Code reviews

All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose.