Awesome List Template
Curated awesome list: badge title, description, Contents, categorised entries, contribution rules, CC0 licence advice
使用方法: Use to start a curated awesome-[topic] list. Define the scope sentence and categories first, then add entries in the exact '- [Name](link) - Description.' format. The main pitfall is collecting links without curation; run awesome-lint before publishing.
预览
Awesome [Topic] Awesome
[A short, specific description of the list. Example: "A curated list of tools, libraries and learning resources for building local-first web applications."]
[One or two sentences of extra context: who the list is for, what is in scope and what is deliberately left out. Example: "This list covers open-source projects that keep user data on the device by default. Hosted services that require an account are out of scope."]
Contents
Libraries
Projects to use in your own code, sorted alphabetically within each group.
Data synchronisation
- Example Sync - CRDT-based sync engine with a pluggable transport.
- Example Store - Reactive IndexedDB wrapper with offline queries.
Storage
- Example DB - Embedded SQL database compiled to WebAssembly.
- Name - Description ending with a full stop.
Tools
- Example Inspector - Browser extension to inspect local databases.
- Name - Description ending with a full stop.
Articles
- Local-first software - Essay that defines the seven ideals of local-first apps.
- Name - Description ending with a full stop.
Talks
- Building offline apps - Conference talk on conflict resolution in practice.
Related lists
- Awesome Related Topic - Neighbouring topic with some overlap.
Contributing
Contributions are welcome. Read the contribution guidelines first. In short:
- Search previous suggestions before making a new one, to avoid duplicates.
- Make one pull request per suggestion and use the title format
Add [Name]. - The resource must be useful, actively maintained, and documented in English.
- Use the entry format
- [Name](link) - Description.and keep the description concise. - Add the entry at the end of the relevant category, or alphabetically if the category is sorted.
- Check spelling and grammar, and remove trailing whitespace.
About this template
This section explains the conventions and should be removed before publishing.
- Name. Lists are named
awesome-[topic]as a repository andAwesome [Topic]as the heading, with the Awesome badge to the right of the title. - Scope. A list should be about one focused topic and be useful to more than its author. Avoid lists that only collect links without judgement.
- Contents. The table of contents is titled
Contentsand links to the H2 sections in order. - Licence. Add a
LICENSEfile to the repository. The awesome guidelines recommend CC0 for lists so anyone can reuse the content. Code licences such as MIT are not intended for lists of links. - Files. Add
contributing.mdwith the rules above and a code of conduct. - Submitting. After the list is at least 30 days old and linted clean, it can be proposed to the main awesome list following its pull request rules.
Standard and licence note
Based on the awesome manifesto and list guidelines published at https://github.com/sindresorhus/awesome (entry format, Contents section, badge, contribution file and CC0 recommendation). Original text written for this collection; example entries are placeholders. Template licence: MIT.
相关模板
Architecture Decision Record (ADR) Template
Lightweight Nygard-style ADR: status, context, decision, consequences, alternatives, related decisions, lifecycle and log
软件与工程AGENTS.md Template for AI Coding Agents
Repository instructions for AI coding agents: setup, build and test commands, conventions, architecture map, PR and security rules
软件与工程REST Endpoint Reference Template
One REST endpoint: auth, parameter tables, request example, responses per status, RFC 9457 errors, limits, idempotency, paging