ESPOS Project

ESPOS Home GitHub repo

The ESPOS Project aims to create a text operating system on ESP32 Hardware.

Contribution Guidelines

Thank you for your interest in contributing to ESPOS! This project is an open-source operating system for ESP32 built entirely in Arduino (.ino) format. Contributions are welcome and encouraged! Please follow these guidelines to ensure a smooth collaboration.

📜 General Rules

• Be respectful and maintain a positive environment.
• All contributions must comply with the GNU GPLv3 License.
• Before submitting major changes, open an issue to discuss them.
• Ensure all code is well-documented and tested on ESP32 hardware.

🔧 Setting Up the Development Environment

1. Install Arduino IDE (latest version) or use Arduino CLI.
2. Install ESP32 board support from the Board Manager.
3. Clone the repository:

   git clone https://github.com/espos-project/espos.git  
   cd espos 

4. Open the .ino files in Arduino IDE.

🚀 How to Contribute

🐞 Reporting Issues

• Clearly describe the bug or feature request.
• Provide steps to reproduce the issue.
• Include logs or error messages if available.

🔨 Submitting Code Changes

1. Fork the repository and create a new branch:

   git checkout -b feature/new-feature  

2. Follow the coding standards (see below).
3. Test your code on an ESP32 device.
4. Commit your changes with a clear and concise message:

   git commit -m "Added task scheduler for ESPOS"  

5. Push your branch and create a Pull Request (PR).

📝 Coding Standards

• Use camelCase for variable and function names.
• Code should be modular and commented.
• Follow Arduino C++ best practices.
• Use #define or constants instead of hardcoded values.
• Keep functions short and reusable.

✅ Pull Request (PR) Checklist

Before submitting a PR, ensure:

• The code is tested on ESP32 hardware.
• The code follows Arduino style conventions.
• The PR includes a clear description of changes.

📜 Licensing

By contributing to this repository, you agree that your contributions will be licensed under the GNU GPLv3 License. This ensures that ESPOS remains free and open-source, and any derivative work must also remain open-source under the same license.

📨 Need Help?

• Join the GitHub Discussions.
• Open an Issue for questions or support.
  Happy coding! 🚀