Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
80 lines (51 loc) · 1.87 KB

CONTRIBUTING.md

File metadata and controls

80 lines (51 loc) · 1.87 KB

Contributing to Composable

Thanks for your interest in contributing! 🎉 This project is meant to be a fun and valuable resource for the Android community, and contributions of all kinds are welcome.

How to Contribute

1. Fork & Clone

  • Fork the repository on GitHub

  • Clone your fork locally

    git clone https://github.com/cinkhangin/composable.git
cd composable

2. Create a Branch

  • Create a feature branch for your contribution:

    git checkout -b feature/my-awesome-component

3. Make Your Changes

  • Add or improve a Jetpack Compose UI component, animation, or interaction
  • Follow Kotlin and Compose best practices
  • Keep code clean and modular

4. Test Your Changes

  • Make sure the app compiles and runs on a recent Android emulator/device
  • Verify that your addition doesn’t break existing demos

5. Commit & Push

  • Commit with a clear message:

    git commit -m "Add new animated button component"

  • Push your branch:

    git push origin feature/my-awesome-component

6. Submit a Pull Request

  • Open a pull request against the develop branch
  • Clearly describe your changes and (if possible) include screenshots or screen recordings

Guidelines

  • Code style: Use idiomatic Kotlin and Jetpack Compose conventions
  • Components: Keep them self-contained and easy to understand
  • Naming: Choose descriptive and consistent names
  • Docs: Add comments if your code is complex or introduces new patterns

Need Ideas?

Not sure where to start? Here are some ideas:

  • Improve existing components (better theming, accessibility, responsiveness)
  • Fix bugs or improve performance
  • Enhance documentation

Code of Conduct

Please be respectful and considerate when interacting with others in the community. Let’s keep this space friendly and welcoming. ❤️