mirror of
https://github.com/m3y54m/Embedded-Engineering-Roadmap.git
synced 2026-10-03 04:18:00 +03:00
Add CONTRIBUTING.md with contributor guidelines
This commit is contained in:
@@ -0,0 +1,37 @@
|
||||
# Contributing to Embedded Engineering Roadmap
|
||||
|
||||
We welcome contributions from everyone! To ensure a smooth collaboration, please follow these guidelines:
|
||||
|
||||
## Practical Advice
|
||||
- Focus on delivering actionable content that can help others in their embedded engineering journey.
|
||||
- Provide code snippets, examples, and hands-on projects when possible.
|
||||
|
||||
## Clarity
|
||||
- Write in clear and concise language. Avoid jargon unless necessary; if you use technical terms, provide definitions.
|
||||
- Use headings, bullet points, and lists to organize content effectively.
|
||||
|
||||
## Resource Quality
|
||||
- Ensure that all referenced resources are reputable and up-to-date.
|
||||
- Link to official documentation, tutorials, and articles that enhance the understanding of the topic.
|
||||
|
||||
## Organization
|
||||
- Keep the structure of your contributions consistent with the existing files in the repository.
|
||||
- Follow the existing naming conventions and organization patterns.
|
||||
|
||||
## Accuracy
|
||||
- Verify facts and ensure that the content is technically correct.
|
||||
- If you are unsure about something, seek clarification or additional resources.
|
||||
|
||||
## Respectful Collaboration
|
||||
- Treat all contributors with respect. Constructive feedback is encouraged.
|
||||
- Be open to different perspectives and ideas.
|
||||
|
||||
## Inclusivity
|
||||
- Encourage contributions from diverse backgrounds and perspectives.
|
||||
- Avoid language that may exclude or alienate others.
|
||||
|
||||
## Prioritized Topics
|
||||
- Focus on the topics outlined in the Embedded Engineering Roadmap.
|
||||
- Contribute to areas that you are passionate about and have expertise in.
|
||||
|
||||
Thank you for helping to improve the Embedded Engineering Roadmap! We appreciate your contributions.
|
||||
Reference in New Issue
Block a user