Skip to content

Commit 0c11d50

Browse files
committed
Add CONTRIBUTING.md with contributor guidelines
1 parent d2fba71 commit 0c11d50

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

CONTRIBUTING.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Contributing to Embedded Engineering Roadmap
2+
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.

0 commit comments

Comments
 (0)