Skip to content

Commit a9689ce

Browse files
authored
Update CONTRIBUTING.md
1 parent 08fdaa6 commit a9689ce

File tree

1 file changed

+24
-35
lines changed

1 file changed

+24
-35
lines changed

CONTRIBUTING.md

Lines changed: 24 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,26 @@
11
# Contributing to Embedded Engineering Roadmap
22

3-
We welcome contributions from everyone! To ensure a smooth collaboration, please follow these guidelines:
4-
5-
## Practical Advice
6-
- Focus on delivering actionable content that can help others in their embedded engineering journey.
7-
- Provide code snippets, examples, and hands-on projects when possible.
8-
9-
## Clarity
10-
- Write in clear and concise language. Avoid jargon unless necessary; if you use technical terms, provide definitions.
11-
- Use headings, bullet points, and lists to organize content effectively.
12-
13-
## Resource Quality
14-
- Ensure that all referenced resources are reputable and up-to-date.
15-
- Link to official documentation, tutorials, and articles that enhance the understanding of the topic.
16-
17-
## Organization
18-
- Keep the structure of your contributions consistent with the existing files in the repository.
19-
- Follow the existing naming conventions and organization patterns.
20-
21-
## Accuracy
22-
- Verify facts and ensure that the content is technically correct.
23-
- If you are unsure about something, seek clarification or additional resources.
24-
25-
## Respectful Collaboration
26-
- Treat all contributors with respect. Constructive feedback is encouraged.
27-
- Be open to different perspectives and ideas.
28-
29-
## Inclusivity
30-
- Encourage contributions from diverse backgrounds and perspectives.
31-
- Avoid language that may exclude or alienate others.
32-
33-
## Prioritized Topics
34-
- Focus on the topics outlined in the Embedded Engineering Roadmap.
35-
- Contribute to areas that you are passionate about and have expertise in.
36-
37-
Thank you for helping to improve the Embedded Engineering Roadmap! We appreciate your contributions.
3+
Contributions from everyone are welcomed. To keep the roadmap practical, accessible, and high quality, the following guidelines should be followed:
4+
5+
## 1. Prioritize Beginner-Friendliness
6+
- Resources and explanations understandable for beginners should be added.
7+
- Advanced or specialized topics are welcomed and their inclusion can enrich the roadmap, but they should be explicitly labeled as advanced so beginners are not overwhelmed when choosing resources.
8+
9+
## 2. Resource Selection Policy
10+
- Free and open resources are preferred to maximize accessibility.
11+
- Paid resources may be included only if they clearly offer more value than existing free options; low-quality paid/free content should not be promoted.
12+
- The list should not be spammed with every publication from the same author or creator solely due to their reputation or personal preference. Each resource should be added for a clear reason, with usefulness especially for beginners prioritized.
13+
- Resources should be up-to-date, reliable, and organized under relevant headings.
14+
15+
## 3. Clarity & Structure
16+
- Clear and direct language should be used. Unnecessary jargon should be avoided. If technical terms are used, simple explanations should be added.
17+
- Bullet points and lists should be used for readability and structure.
18+
19+
## 4. Technical Accuracy
20+
- The correctness and relevance of all information and links should be verified.
21+
- If uncertainty exists, feedback should be requested in the pull request.
22+
23+
## 5. Roadmap Alignment
24+
- Contributions should match the topics and structure of the roadmap.
25+
- Areas where contributors have experience or genuine interest should be focused on.
26+
- If a new topic is thought to make the roadmap more complete, it may be suggested. New topics should be proposed thoughtfully, considering their usefulness and relevance for other learners.

0 commit comments

Comments
 (0)