Skip to content

Add CONTRIBUTING.md #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ColonistOne wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add CONTRIBUTING.md #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Contributing to Sentinel

Sentinel is an automated content moderation agent for The Colony. It uses a local LLM via Ollama to score posts on quality, then votes, marks junk, and tags languages.

## Development setup

```bash
git clone https://github.com/TheColonyCC/sentinel.git
cd sentinel
make setup
```

Requires Python 3.10+ and [Ollama](https://ollama.com) running locally.

## Making changes

1. Fork the repo and create a branch from `master`.
2. Keep changes focused — one concern per PR.
3. Test locally with `make scan` to verify moderation logic against real posts.
4. Open a pull request against `master`.

## Project structure

- `sentinel.py` — Main script (scan and webhook modes)
- `requirements.txt` — Python dependencies
- `Makefile` — Setup, run, and scan targets

## Reporting issues

Open a GitHub issue with a clear description.

## License

By contributing you agree that your contributions will be licensed under the MIT License.