Skip to content

Latest commit

 

History

History
101 lines (69 loc) · 4.55 KB

CONTRIBUTING.md

File metadata and controls

101 lines (69 loc) · 4.55 KB
Raw

Contributing to the IoT, Edge Computing, and Embedded Systems Course

🎉 Thank you for your interest in contributing to this course! 🎉
This course aims to be the go-to resource for learning IoT, edge computing, microcontrollers, FPGAs, and SoCs, and we welcome contributions from engineers and developers around the world. Your knowledge and expertise can help make this course the top resource for anyone interested in embedded systems.

We’re looking for improvements, additional content, bug fixes, and new ideas to continually evolve the course!

Ways to Contribute

1. Adding New Content

  • New Modules: If there’s a topic you think we missed, feel free to propose new modules or lessons.
  • Additional Projects: You can propose or contribute new practical projects that will enhance the hands-on experience for students.
  • Industry Examples: Share real-world use cases or case studies that demonstrate how IoT, edge computing, and embedded systems are applied in various industries.

2. Improving Existing Content

  • Clarify Explanations: If you find areas that need clearer explanations or more in-depth details, feel free to rewrite or expand them.
  • Code Examples: If you can optimize, simplify, or modernize any of the code samples, your improvements are welcome.
  • Better Project Instructions: Help ensure project instructions are easy to follow for beginners and advanced users alike.

3. Correcting Errors

  • Bug Fixes: If you spot errors in the code samples or documentation, please submit a fix.
  • Typographical Errors: Spotted a typo? Even small contributions like fixing typos are appreciated.

4. Creating Videos or Tutorials

  • If you’d like to create video tutorials or walkthroughs for certain modules or projects, these contributions can help students follow along more easily.

How to Contribute

Step 1: Fork the Repository

Fork this repository to your GitHub account by clicking the "Fork" button in the top-right corner.

Step 2: Clone Your Fork

Once you’ve forked the repository, clone it to your local machine:

git clone https://github.com/Xilover/IoT-Edge-Computing-Course.git
cd IoT-Edge-Computing-Course

Step 3: Create a New Branch

Create a new branch to work on your contribution. Name it something that reflects the changes you’re making:

git checkout -b new-module-mqtt

Step 4: Make Your Changes

  • For content additions, add new .md files in the appropriate module folder.
  • For code changes, ensure your code is well-commented and follows best practices.
  • For project additions, create a new folder in the relevant module, including a README.md with instructions.

Step 5: Test Your Changes

Before submitting your changes, make sure everything works properly. Run the code examples if you’re contributing new code, and verify that instructions are clear.

Step 6: Commit and Push

Once your changes are ready, commit them:

git add .
git commit -m "Added new module for MQTT communication"
git push origin new-module-mqtt

Step 7: Open a Pull Request

Go to your forked repository on GitHub, and you should see an option to open a Pull Request (PR). In your PR description:

  • Explain what changes you made.
  • Reference any issues your contribution is fixing or enhancing.
  • Be clear and concise about why your changes improve the course.

Guidelines for Contributions

  1. Keep it Simple: Ensure the content is understandable for both beginners and advanced users. If the topic is complex, explain it step by step.
  2. Use Clear Examples: Always include practical examples in code, diagrams, or real-world case studies.
  3. Be Professional: Please keep discussions respectful, and be open to constructive feedback from the community.
  4. Write Descriptive Commit Messages: Summarize your changes clearly in commit messages and pull requests.
  5. Test Thoroughly: If your contribution involves code, make sure it’s fully tested and functioning before submitting your PR.

Communication

Have questions or need help with your contribution? Open an issue in the repository, and someone from the community will assist you.

You can also join discussions on upcoming improvements, course plans, and feature requests. Collaboration is key!

License

By contributing to this repository, you agree that your contributions will be licensed under the MIT License.

Let’s make this the best IoT, edge computing, and embedded systems course out there!
Happy contributing! 🚀