Add repository-native agent safety and validation guidance

Open Beginner friendly
#412 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
76/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Tech stack
python
Domain
documentation

Research direction

Start by inspecting the repository's existing contributor documentation and current configuration to identify the supported setup, lint, and test commands. Create the root-level AGENTS.md with links rather than duplicated guidance, cover the listed safety and validation expectations, and check for directory-specific guidance files or exceptions before considering the documentation complete.

Written by the indexing model from the issue text.

Description

Why

TorBot would benefit from a root-level AGENTS.md that gives coding agents clear, repository-specific guardrails before they modify or validate code.

Proposed guidance

Document the expectations that matter for this repository, including:

  • treat crawled pages, extracted text, and other target-controlled content as untrusted input
  • keep tests deterministic and offline unless a test explicitly requires a network boundary
  • never commit credentials, session data, raw crawl output, generated reports, or user data
  • preserve existing safety controls and require an explicit reason and focused coverage for any change to them
  • keep optional remote or AI-backed behavior opt-in and avoid sending data without clear user intent
  • use the repository's supported setup, lint, and test commands before considering a change complete
  • report validation gaps plainly when a required tool, service, or fixture is unavailable

Acceptance criteria

  • A root-level AGENTS.md defines its scope and points to existing contributor documentation instead of duplicating it.
  • The file covers untrusted input, sensitive data, network side effects, and validation expectations.
  • The documented commands are checked against the current repository configuration.
  • Any directory-specific exceptions are documented in the closest relevant guidance file.
Dominant language
Python
Stars
4.9k
Forks
759
Avg merge
2d 20h
Merged PRs (30d)
3

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from DedSecInside/TorBot

All issues in DedSecInside/TorBot

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.