awesome-shodan-queries/contributing.md

2.1 KiB

Contribution Guidelines

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Adding an awesome search query

Ensure your Issue or Pull Request includes the following information or follows this format:

  • Narrow down the results as much as possible using Shodan's filters...but not too much, be careful not to exclude people trying to hide via security by obscurity! (Geniuses with SSH listening on port 2222 instead of 22, for example. 🙄)
  • Include a link to the search results page with the symbol at the end of the H3 heading. Copy the EXACT query into the Shodan search box and copy and paste the resulting URL to make sure it's identical and encoded properly.
  • Don't include a country: filter. It's okay if a certain technology is only used by a certain country, but there's no need to artifically limit the results to that locale alone. Leave that up to the searcher.
  • Screenshots are unnecessary, unless they add something interesting, shocking, or out of the ordinary — like a billboard for burgers or a ransomware-infected desktop.
  • Descriptions are also unnecessary, unless you have a link you'd like to include to a page with more information, like an important CVE.
  • If you have a question, just ask! No stupid questions around here.

Updating your Pull Request

Sometimes, a maintainer of this list will ask you to edit your Pull Request before it is included. This is normally due to spelling errors or because your PR didn't match the list guidelines above.

Here is a write up on how to change a Pull Request, and the different ways you can do that.