|
| 1 | +# Contributing to awesome-topics |
| 2 | + |
| 3 | +Thanks for helping improve this curated map for developers — contributions from anyone are welcome. |
| 4 | + |
| 5 | +What to add |
| 6 | +- Ensure the resource is high-quality, relevant to software engineering or developer learning, and not already listed. |
| 7 | +- Proposed entry format (in a single list line): |
| 8 | + - [Name](URL) — Short neutral description. (tags) |
| 9 | + - Example: `- [Free Coding Course](https://example.com) — A beginner-friendly course on web fundamentals. (category:learning, language:js, difficulty:beginner)` |
| 10 | + |
| 11 | +Tags |
| 12 | +- Use simple tags in parentheses after the description. Common tags: category, language, difficulty, license. |
| 13 | +- Tags help readers filter the list and let scripts export machine-readable data. |
| 14 | + |
| 15 | +How to contribute |
| 16 | +1. Open a pull request that adds or updates entries in the README under the appropriate section. |
| 17 | +2. Keep changes focused and small (one logical change per PR is ideal). |
| 18 | +3. If your change is large (reorganizing many items or adding whole learning paths), open an issue first to discuss structure. |
| 19 | + |
| 20 | +Pull request checklist (for contributors) |
| 21 | +- [ ] I checked for duplicates. |
| 22 | +- [ ] The entry has a short description and tags. |
| 23 | +- [ ] Links work (or a note explains a known issue). |
| 24 | +- [ ] Changes are limited to the intended section. |
| 25 | + |
| 26 | +Review & maintenance |
| 27 | +- This project is community-maintained. Anyone can review and suggest improvements. |
| 28 | +- There is no fixed review deadline — maintainers and community members will triage and review PRs as available. |
| 29 | +- If you want to take responsibility for a category, mention it in an issue or comment and the community can coordinate. |
| 30 | + |
| 31 | +Automation & formatting |
| 32 | +- Try to keep list formatting consistent (Markdown list items). |
| 33 | +- Consider running markdown linters locally before opening large PRs. |
| 34 | + |
| 35 | +Thanks — your contribution helps other developers find better resources. |
0 commit comments