Skip to content

Latest commit

 

History

History
24 lines (18 loc) · 1.07 KB

CONTRIBUTING.md

File metadata and controls

24 lines (18 loc) · 1.07 KB

Firstly, I appreciate for investing your time and effort to contribute 🎉👍 Let's build it Together ✌.

Prerequisites

  • Experience in Kotlin
  • Have knowledge working with Android Jetpack components
  • Working experience with MVVM architecure
  • Perosnally used or familiar about Android Architecture components
  • Idea about Kotlin Coroutines and Flows
  • Writing Unit and UI tests
  • Last but not least, if you are new to any of above topics we can always learn while working together

Tools

  • Android Studio 4.2 Canary 15

Contributing guidelines for Plamsa

  • Fork the project, develop and test
  • Create a issue/ feature request with proper description along with PR of well tested code(better to include unit tests)
  • Make sure you follow existing design patterns/architecture which is already in use
  • Please follow Kotlin Style guide for clean and readable code
  • Document your code always or atleast the complex part with proper description
  • Run lint checks and make sure there are no warnings in your code.