Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/JasonHonKL/spy-search/llms.txt

Use this file to discover all available pages before exploring further.

Spy Search is an open-source project released under the MIT License. The project thrives on community involvement, and all kinds of contributions are welcome — from fixing a typo in the docs to shipping a major new feature.

​
Ways to Contribute

There are many ways to get involved:
  • Bug reports — Help identify issues so they can be fixed quickly.
  • Feature requests — Share ideas that would make Spy Search more useful.
  • Pull requests — Submit code improvements, bug fixes, or new functionality.
  • Documentation improvements — Clarify guides, fix inaccuracies, or add missing content.

​
Submitting a Pull Request

1

Fork the repository and create a branch

Fork spy-search on GitHub, then create a new branch off the latest main branch for your changes.
git checkout -b my-feature-branch main
2

Make your changes

Implement your fix or feature. Make sure your commit messages are clear and your PR description explains:
  • What the change does
  • Why it is needed
  • How to test it
The project uses Black as the standard Python code formatter. Run it before committing:
black .
3

Rebase on the latest main branch

Before opening the PR, ensure your branch is up to date with main to minimise merge conflicts:
git fetch origin
git rebase origin/main
4

Submit the PR

Push your branch and open a pull request on GitHub. Maintainers will review your submission, leave feedback, and merge it once it meets project standards. Please be patient — all reviews are done voluntarily.

​
Reporting Bugs

Found something broken? Please open a GitHub Issue using the Bug Report template and include the following information:
FieldDetails
TitleA short, descriptive summary of the problem
Steps to reproduceNumbered steps that reliably trigger the bug
Expected behaviorWhat you expected to happen
Actual behaviorWhat actually happened
EnvironmentOS, browser (if applicable), and Spy Search version
Screenshots or screen recordings are also very helpful where applicable. Maintainers will acknowledge your issue, label it appropriately, and work with you toward a resolution.

​
Requesting Features

Have an idea for a new capability? Open a GitHub Issue using the Feature Request template and describe:
  1. The problem — What frustration or gap does this address?
  2. Your proposed solution — How would you like it to work?
  3. Alternatives considered — Any other approaches you thought about?
The more context you provide, the easier it is for maintainers and the community to evaluate and prioritise your request.

​
Code of Conduct

Spy Search follows the Contributor Covenant Code of Conduct. All participants are expected to:
  • Be respectful — Value differing opinions, viewpoints, and experience levels.
  • Give constructive feedback — Critique ideas, not people, and accept feedback graciously.
  • Show empathy — Be kind and considerate in all interactions.
  • Take responsibility — Own mistakes, apologise where appropriate, and learn from them.
The following behaviours are not tolerated in any community space:
  • Harassment, trolling, or personal attacks
  • Sexualised language, imagery, or unwanted advances
  • Publishing others’ private information without consent
  • Any conduct that would be considered inappropriate in a professional setting
Violations may result in a warning, temporary ban, or permanent ban depending on severity. Community leaders are responsible for enforcement and will act fairly and transparently.

​
Community

Join the conversation and get help from the community on Discord: Join the Spy Search Discord →
The development environment requires Python 3.13 and Node.js 22. See the Installation guide for full setup instructions.

Build docs developers (and LLMs) love

Get started for freeTalk to us