Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
92 lines (61 loc) · 2.78 KB

CONTRIBUTING.md

File metadata and controls

92 lines (61 loc) · 2.78 KB
Raw

🤝 Contributing to MobileByteLabs

Hello! 👋 We're thrilled you're considering contributing to MobileByteLabs – a collective focused on advancing mobile development through open-source innovation, especially with Kotlin Multiplatform.

📜 Code of Conduct

Please make sure to read and adhere to our Code of Conduct. We’re an inclusive and respectful space for developers from all walks of life.

🛠 Ways to Contribute

You can contribute in several ways:

  • 📦 Develop features or fix bugs in existing repositories
  • 🧪 Test and provide feedback on alpha/beta releases
  • 📝 Improve documentation, READMEs, or tutorials
  • 💡 Propose ideas through issues or discussions
  • 🎨 Contribute to UI/UX design (Figma prototypes, assets, etc.)
  • 🧠 Share knowledge by writing blog posts or guides

🚀 Getting Started

  1. Fork the repository you'd like to contribute to.

  2. Clone your fork:

    git clone https://github.com/your-username/repository-name.git

  3. Set upstream remote:

    git remote add upstream https://github.com/MobileByteLabs/repository-name.git

  4. Create a branch for your feature or fix:

    git checkout -b feature/your-feature-name

  5. Make your changes, commit them, and push:

    git add .
git commit -m "Add: Meaningful commit message"
git push origin feature/your-feature-name

  6. Open a Pull Request from your forked repository’s branch to our main or develop branch.

Pull Request Guidelines

  • Fork the repo and work on a feature branch.
  • Keep PRs focused – one PR = one fix or feature.
  • Add a clear, descriptive title and summary.
  • Reference related issues using keywords (e.g., Fixes #12).
  • Test your code before creating a PR.
  • For UI/UX changes, attach screenshots or video demos.
  • Be open to feedback and iterate when needed.

Code Style & Best Practices

  • Follow Kotlin coding conventions for Kotlin-based projects.
  • Use consistent indentation and naming conventions.
  • Avoid large PRs – break them into smaller parts when possible.
  • Add comments for clarity where needed.
  • Prefer clear, readable code over clever but obscure tricks.

💬 Community & Support

Thank you for helping us build an amazing mobile dev ecosystem.
Together, we're shaping the future of open-source innovation 🚀

— Team MobileByteLabs