Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
129 lines (85 loc) · 2.89 KB

CONTRIBUTING.md

File metadata and controls

129 lines (85 loc) · 2.89 KB

Contributing to CoreX

👋 Welcome! We're excited that you're interested in contributing to our Jetpack Compose project. Contributions of all kinds are welcome — from bug fixes and documentation improvements to new features.

Table of Contents

Code of Conduct

Please read and follow our Code of Conduct to help create a welcoming environment for everyone.

Getting Started

To get your environment ready:

  1. Fork the repo and clone it locally:

    git clone https://github.com/mcbabo/CoreX.git
cd REPO-NAME

  2. Set up your IDE We recommend using Android Studio (latest stable version) with Kotlin and Jetpack Compose support enabled.

  3. Run the project Open the project in Android Studio and hit Run.

How to Contribute

🚀 Code Contributions

  • Fix bugs
  • Add new Jetpack Compose components
  • Improve accessibility
  • Write or improve tests
  • Refactor existing code
  • Improve performance

📝 Documentation Contributions

  • Improve README, CONTRIBUTING, or other markdown files
  • Add usage examples
  • Update or add Javadoc/KDoc to components

Style Guide

  • Use Kotlin idiomatic practices
  • Follow Jetpack Compose best practices (e.g., composable naming, recomposition optimization)
  • Use the default Kotlin code style settings in Android Studio
  • Ensure null-safety and type-safety

Creating a Pull Request

  1. Create a feature or fix branch:

    git checkout -b feature/your-feature-name

  2. Make your changes and commit:

    git commit -m "Add feature: description here"

  3. Push to your fork:

    git push origin feature/your-feature-name

  4. Open a Pull Request against master with a clear description and link any relevant issues.

Before submitting a PR:

  • Ensure the app compiles
  • Run tests (./gradlew test) if available
  • Follow the code style guidelines
  • Document your changes

Reporting Issues

Found a bug or have a feature request? Please:

  1. Check existing Issues

  2. If none exists, create a new one and provide:

    • Clear description of the issue
    • Steps to reproduce
    • Expected vs. actual behavior
    • Screenshots or logs if applicable

Community & Support

Join the discussion in the Discussions tab.

If you have questions or want feedback, feel free to open a thread there.

Thank you for contributing! 🎉