Prepare repo for awesome-lists submission#11
Conversation
Adds the files and structural fixes that the sindresorhus/awesome pull-request template and awesome-lint require: - Add CC0 LICENSE so GitHub detects the license. - Add contributing.md with contribution guidelines. - Rename README.MD to README.md (lowercase extension). - Replace deprecated rawgit badge with the canonical awesome.re badge. - Rewrite the top-of-readme description to describe the topic, not the list, and drop the duplicate awesome-honeypots link. - Demote section headings from H1 to H2 so the list has a single H1. - Drop "Related Lists" from the Contents section per awesome-lint. - Move the fork-of-a-fork note into a Footnotes section at the bottom. - Reformat list items so the link is followed by a dash and an uppercase description, with years moved into the description. - Inline the nested Hacker News bullet and the MITRE Engage / D3FEND sub-repository bullets to satisfy awesome-list-item rules. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 0a7ba97550
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| - [Q-Cowrie: Reinforcement Learning for Adaptive Honeypot Deception](https://link.springer.com/article/10.1007/s10207-026-01221-5) (2026) - presents “Q-Cowrie,” a reinforcement learning-enhanced Cowrie honeypot that models attacker decisions with an MDP and adapts responses during attacker interaction. | ||
| - [Deception and Detection: Why Artificial Intelligence Empowers Cyber Defense over Offense](https://direct.mit.edu/isec/article/50/3/86/135683/Deception-and-Detection-Why-Artificial) (2026) - argues that AI automation benefits cyber defense more than offense, widening an offense-defense automation gap as stakes increase. | ||
|
|
||
| - [Demystifying Deception Technology: A Survey](https://arxiv.org/abs/1804.06196) - Survey of deception taxonomies, deployment models, and evaluation gaps (2018). |
There was a problem hiding this comment.
AGENTS.md ("Keep existing style consistent") specifies the paper format as - [Title](URL) (YEAR) - short description., but this change rewrites papers to - [Title](URL) - ... (YEAR). (for example here and throughout the section). This creates a direct mismatch with the repository’s documented review/update contract and will cause ongoing formatting churn for contributors and agents that follow AGENTS.md.
Useful? React with 👍 / 👎.
| @@ -1,33 +1,31 @@ | |||
| # 🥷 Awesome Deception [](https://github.com/sindresorhus/awesome) | |||
| # 🥷 Awesome Deception [](https://awesome.re) | |||
There was a problem hiding this comment.
This rename changes the canonical readme path to README.md, but AGENTS.md still instructs contributors to update/check README.MD and run git diff -- README.MD. Leaving those instructions stale breaks the documented pre-commit checklist and misdirects future reviews/automation to a non-existent path; the guidance should be updated in the same change set.
Useful? React with 👍 / 👎.
Moves the pointer to awesome-honeypots back into the top-of-readme description so newcomers see it immediately. Drops the Related Lists section to avoid the duplicate-link awesome-lint error; that section only contained the same link. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Puts the year back between the link and the dash so paper-style entries match the format AGENTS.md documents: - [Title](URL) (YEAR) - Description. awesome-lint accepts this form as long as the description after the dash starts with an uppercase character (which it does, in every case here), so this also keeps the lint clean. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
The readme moved from README.MD to README.md in this branch but AGENTS.md still pointed contributors and the pre-commit checklist at the old path. Updates the three references so future Codex runs follow the right path. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Lints README.md on pushes to main and on every pull request so formatting regressions are caught before merge. The PR template allows a lint workflow but explicitly says no CI badge in the readme, so this only adds the workflow file. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 participant
Summary
This PR makes the changes that sindresorhus/awesome requires before this list can be submitted to the main awesome-lists. The submission can go in once this is merged and the 30-day-since-last-substantive-change clock has had a chance to settle.
Why
For the list to be accepted at https://github.com/sindresorhus/awesome, the repo and readme must satisfy the pull request template, the awesome manifesto, and
awesome-lint. Today the repo is missing some of those requirements. Runningawesome-lintagainstmainreports 53 errors covering: missing license, missingcontributing.md, wrong file extension, deprecated badge URL, multiple H1 headings, lowercase descriptions, list items where the year sits between the link and the dash, and a duplicate link. After this PR there is only one residual lint error and it auto-resolves when this is merged (license detection runs against the default branch on GitHub).What's already fine
The repo already passes a few of the harder-to-fix requirements:
main, notmaster.awesome-deception).awesomeandawesome-list.awesome-deceptionis currently listed in awesome-lists; the closest entry isawesome-honeypots, which has a different scope.What this PR changes
Files added:
LICENSE- CC0 1.0 Universal. Required ("a code license like MIT, BSD, Apache, GPL, etc, is not acceptable"). Once onmain, GitHub will auto-detect it.contributing.md- Contribution guidelines, also required.README.MD->README.md:awesome-lint(Unexpected file extension MD, expected mdx or md).cdn.rawgit.combadge URL with the canonicalhttps://awesome.re/badge.svg.awesome-honeypotslink from the description (it already lives in Related Lists).#to##so there is a single H1, fixing 14awesome-heading/no-multiple-toplevel-headingsviolations.Related Listsfrom the Contents section.awesome-lintflags it underawesome-toc(ToC should not contain section "Related Lists"); the Related Lists section itself is preserved.Footnotessection at the bottom, in line with the manifesto's guidance againstInspired by awesome-foostyle notes near the title.- [Title](url) - Description (YEAR).). This fixes theawesome-list-itemviolations on every paper entry plus a handful of articles, the Taxonomy guide, and the MITRE/D3FEND framework entries (which previously used nested sub-bullets that the linter rejects).awesome-lint before / after
Before, against
main: 53 errors.After, against this branch (with
GITHUB_TOKENset so GitHub-property checks run):The remaining error queries the GitHub API for the default branch's detected license. It will go away as soon as this PR merges and GitHub picks up the CC0 LICENSE file on
main.Test plan
npx awesome-lintis clean apart from the license-on-main check.awesomeandawesome-list.LICENSEcontains the full CC0 1.0 Universal legal code.npx awesome-lintagainstmainto confirm 0 errors.Add Deception, four substantive reviews on other PRs, etc.).