Get involved

Where the code lives, how to ask a question, how to contribute, and how to sign off your commits.

Everything Philterd builds is open source under the Apache 2.0 license and developed in the open at github.com/philterd.

Ask a question

The Philterd Slack is the quickest way to talk with other contributors: checking an approach before you write it, getting unstuck on a build, or finding out which repository a change belongs in. Never paste real PII, PHI, or production logs there. Use made-up examples instead.

Report a problem

File it in the repository where the work would happen. A Phileas detection bug belongs in phileas, a proxy bug in philter-ai-proxy, and so on. Detection is probabilistic, so a report that includes the input text, the policy, and what you expected is far more actionable than one that does not.

If you find a security issue, do not open a public issue. See the security policy.

Contribute code

Open issues labelled good first issue are the easiest place to start. The list is short, so if nothing there fits, open an issue describing what you want to change before writing code. That avoids work going in a direction the project cannot merge.

Every commit in a pull request must be signed off under the Developer Certificate of Origin (DCO), which certifies that you wrote the change or otherwise have the right to submit it under the project’s license. A required DCO check on each pull request verifies it.

Refer to CONTRIBUTING.md in the individual project for details.

Contribute without writing code

  • Report a detection that was missed or a false positive. Real-world examples are the most useful thing the projects receive.
  • Share a redaction policy that works for your domain, through pii-redaction-policies.
  • Improve documentation. Every project’s docs live in its own repository next to the code.

Commercial support

If you need help deploying or tuning any of this, get in touch.

Sign off your commits

Pull requests need a DCO sign-off on every commit.

New commits

Add -s when you commit. Git appends a Signed-off-by line with the name and email from your git config.

git commit -s -m "Fix a typo"

Commits already pushed

Sign off the last N commits on your branch, where N is the number of commits in your pull request (3 here), then force-push:

git rebase --signoff HEAD~3
git push --force-with-lease