|
1 | | -# Welcome to the Awesome Topics community ❤️ |
| 1 | +# Contributing to awesome-topics |
2 | 2 |
|
3 | | -Your interest in contributing to "Awesome Topics" is greatly appreciated! By participating, you are helping to create a valuable resource for the developer community. Your contributions play a crucial role in fostering knowledge sharing and helping developers of all levels. Thank you for being a part of our mission to empower the tech community! |
| 3 | +Thanks for helping improve this curated map for developers — contributions from anyone are welcome. |
4 | 4 |
|
5 | | -## How to Contribute |
| 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)` |
6 | 10 |
|
7 | | -1. **Understand Our Approach**: Familiarize yourself with Awesome Topics' approach, emphasizing clear, concise, and accurate explanations of technical topics. |
8 | | -2. **Choose Your Contribution**: Select from the following contribution areas: adding a new topic, editing an existing topic, introducing a new subject, or enhancing the design. |
9 | | -3. **Meet Quality Standards**: Ensure contributions meet our standards for clarity, conciseness, and accuracy. |
10 | | -Review our [Pull Request Template](PULL_REQUEST_TEMPLATE.md) for detailed guidance. |
11 | | -4. **Community Guidelines**: Maintain a respectful and collaborative environment by following the [GitHub Community Guidelines](https://docs.github.com/en/github/site-policy/github-community-guidelines). |
| 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. |
12 | 14 |
|
13 | | -## Terminology |
| 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. |
14 | 19 |
|
15 | | -Before contributing, it's important to understand the key terms we use: |
| 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. |
16 | 25 |
|
17 | | -- **Section**: These represent the top-level divisions in our content structure, organizing related topics into broader categories. In the table of contents, you may find the sections grouped into categories for easier navigation and organization. |
18 | | -- **Topic**: Within each section, "Topics" are the individual topics or entries. Each topic provides a concise and easily understandable explanation of itself. These explanations are presented in a detailed manner and can be expanded or collapsed for convenience. |
| 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. |
19 | 30 |
|
20 | | -## README Structure |
| 31 | +Automation & formatting |
| 32 | +- Try to keep list formatting consistent (Markdown list items). |
| 33 | +- Consider running markdown linters locally before opening large PRs. |
21 | 34 |
|
22 | | -The following template illustrates the preferred structure for README sections. |
23 | | - |
24 | | -``` |
25 | | -<!-- --------------------------------------------------------------------- --> |
26 | | -# Section |
27 | | -<!-- --------------------------------------------------------------------- --> |
28 | | -
|
29 | | -<details><summary><strong>Topic</strong></summary><p> |
30 | | -
|
31 | | -> Lorem Ipsum is simply dummy text of the printing and typesetting industry. |
32 | | -
|
33 | | -</p></details> |
34 | | -``` |
35 | | - |
36 | | -## Contribution Guidelines |
37 | | - |
38 | | -#### 1. **Adding a New Topic**: |
39 | | -- Aim for clarity and conciseness. (Consider using AI tools like ChatGPT for refining your descriptions). |
40 | | - |
41 | | -#### 2. **Editing Existing Topic**: |
42 | | -- Focus on improving clarity, accuracy, and readability. |
43 | | - |
44 | | -#### 3. **Introducing a New Subject**: |
45 | | -- Include at least 5 related topics and don't forget to update the Table of Contents. |
46 | | - |
47 | | -#### 4. **Making Enhancements**: |
48 | | -- For design changes or major structural improvements, please consult [@Mahmoudz](https://github.com/Mahmoudz) before working on your PR. |
49 | | - |
50 | | ---- |
51 | | - |
52 | | -*Thank you for enhancing Awesome Topics with your knowledge!* |
| 35 | +Thanks — your contribution helps other developers find better resources. |
0 commit comments