Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
91 lines (51 loc) · 1.95 KB

CONTRIBUTING.md

File metadata and controls

91 lines (51 loc) · 1.95 KB

Contributing to MikuOS

Thank you for considering contributing to MikuOS! 🎉
We welcome all kinds of contributions — from bug reports and code to design ideas and documentation.

🚀 How to Contribute

1. Fork and Clone

Fork the repo and clone it to your local machine:

git clone https://github.com/antonioscapellato/MikuOS.git
cd MikuOS

2. Create a Feature Branch

Use a descriptive branch name:

git checkout -b feature/your-feature-name

3. Make Your Changes

  • Follow existing code styles.
  • Add tests if applicable.
  • Update documentation if your changes affect usage or configuration.

4. Commit Your Changes

Use clear and concise commit messages:

git commit -m "feat: add speech recognition module"

5. Push and Create a Pull Request

git push origin feature/your-feature-name

Then open a PR on the main MikuOS repository.

📋 What Can You Contribute?

  • 🐛 Bug Reports – Submit detailed issues with reproduction steps.
  • 💡 Feature Suggestions – Share your ideas in Discussions or Issues.
  • 🛠 Code – Fix bugs, implement features, or improve performance.
  • 🧪 Tests – Add unit/integration tests.
  • 📚 Docs – Improve or expand project documentation.

💻 Code Style

  • Use Prettier or the project's formatter for consistent formatting.
  • Write clear, maintainable code with comments where helpful.
  • Keep PRs focused — one feature or fix per PR is ideal.

✅ Pull Request Checklist

  • All existing and new tests pass
  • Code adheres to style guidelines
  • Includes documentation updates (if applicable)
  • Has a clear and descriptive title and body

🤝 Code of Conduct

Please follow our Code of Conduct in all interactions.

📫 Need Help?

  • Open an issue with the question label.
  • Start a discussion on GitHub.
  • Tag the maintainer @antonioscapellato if needed.

Happy hacking! 💙