Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Code of Conduct

SentinelGuard is a technical project for building safer LLM applications. We
want discussion and contribution to be useful, respectful, and evidence-driven.

## Expected Behavior

- Be respectful of different backgrounds, experience levels, and viewpoints.
- Assume good intent, but be willing to clarify impact when something lands
badly.
- Keep technical debate focused on code, docs, security evidence, benchmarks,
and user impact.
- Give credit when building on another person's work or report.
- Be careful with security-sensitive examples, logs, prompts, screenshots, and
test data.

## Unacceptable Behavior

- Harassment, threats, personal attacks, or discriminatory language.
- Publishing private information, credentials, tokens, secrets, or personal
data without permission.
- Sharing exploit details in public issues when responsible disclosure is more
appropriate.
- Trolling, repeated disruption, or bad-faith argument.

## Enforcement

Maintainers may edit, hide, or remove comments; close issues or pull requests;
or restrict participation when behavior harms the project or community.

If you need to report a conduct issue, contact the maintainers through the
project's GitHub issue tracker with a minimal public note, or use a private
maintainer channel if one is available. Do not include secrets or private
personal information in a public report.
86 changes: 86 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
# Contributing

Thanks for helping improve SentinelGuard. Contributions can be code, tests,
benchmark cases, docs, examples, issue reports, deployment recipes, or security
review.

## Good First Contributions

- Add labeled benchmark cases for prompt injection, PII, PCI, PHI, secrets, or
benign negatives.
- Improve examples for Docker, Kubernetes, ECS, EC2, IDEs, or SDK clients.
- Add provider configuration examples for OpenAI-compatible model servers.
- Improve scanner docs with realistic safe test cases.
- Add focused tests around a bug or behavior change.

## Development Setup

```bash
python -m venv .venv
source .venv/bin/activate
pip install -e ".[dev,gateway,monitoring]"
```

Optional model-backed scanner work:

```bash
pip install -e ".[dev,gateway,monitoring,models]"
```

## Run Checks

```bash
ruff check sentinelguard tests examples/test_apps/gateway_test_client.py
pytest
```

For focused gateway work:

```bash
pytest tests/test_gateway.py tests/test_cli.py
```

For docs:

```bash
pip install -r requirements-docs.txt
mkdocs build --strict
```

## Contribution Workflow

1. Open an issue or describe the problem in the pull request.
2. Keep changes focused. Avoid unrelated formatting churn.
3. Add or update tests for behavior changes.
4. Update docs and examples when user-facing behavior changes.
5. Run the relevant checks before opening the pull request.
6. Include screenshots or command output when changing docs, CLI output, or UI
behavior.

## Security And Test Data

- Do not commit real API keys, tokens, credentials, PHI, PCI data, or personal
information.
- Use synthetic examples for secrets, PII, PCI, and PHI.
- If a test needs token-shaped strings, make sure they are fake and documented
as fake.
- For vulnerability reports, follow [SECURITY.md](SECURITY.md) instead of
opening a detailed public issue.

## Documentation Style

Keep docs practical:

- install
- configure
- run
- verify
- troubleshoot

Prefer examples users can copy into local development, Docker, Kubernetes, EKS,
ECS, EC2, or an OpenAI-compatible SDK client.

## License

By contributing, you agree that your contribution will be licensed under the
Apache License 2.0 used by this project.
Loading
Loading