Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
28 lines (23 loc) · 1.41 KB

CONTRIBUTING.md

File metadata and controls

28 lines (23 loc) · 1.41 KB

Contribution

Compose Animation - Mad App is a part of collection of mad apps and they use locally build common module to have consistent ui. So, its recommended to build the common module locally once and sync project to resolve build errors

Common Modules

Common modules can be found at this link follow the instructions there to build common modules locally.

What Can I Contribute?

For a PR or your contribution to be merged it's important to understand the requirements and goal of the repo and for this repo the requirements and goals (have them in bullet points bewlow too) and they are pretty simple build animations in compose and if you have sourced animation from somewhere credit the in README.md or kdoc or better both.

How Can I Contribute?

Contribution could include but not limited to Adding/Enhancing or Bug fixing all PR must target main and must follow the template to create a pr [Feature Template] or [Bug Fix Template]. And if you wish to create a new category aka new feature kindly use the script at scripts/createModule.sh and follow the instructions to create modules clean and error free.

Gist

What to Contribute

  • Enhance/Add Animations
  • Bug Fix
  • Tests
  • code improvements
  • CI/CD Pipelines

How To Contribute

  • Make Sure There are no build errors
  • Follow the templates
  • Make Sure to follow similar structure with other modules