Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
79 lines (51 loc) · 2.01 KB

CONTRIBUTING.md

File metadata and controls

79 lines (51 loc) · 2.01 KB

Contributing to Klyx

Thanks for your interest in contributing to Klyx — a fast, minimalist code editor for Android.

We welcome contributions of all kinds: bug fixes, improvements, documentation, and feature ideas. Please read this guide to get started.

Getting Started

  1. Fork the repository
    Create your own copy of the repo by clicking “Fork” at the top right of the Klyx GitHub page.

  2. Clone your fork

    git clone https://github.com/itsvks19/klyx.git
cd klyx

  3. Set up the project Open the project in Android Studio (Narwhal Feature Drop or later recommended).

  4. Create a new branch

    git checkout -b my-feature-branch

Code Style

  • Use Kotlin best practices.

  • Follow Jetpack Compose naming and structural conventions.

  • Write clear, modular, and maintainable code.

  • Keep UI minimal — Klyx values simplicity.

  • Write meaningful commit messages:

    feat: added support for multi-file tabs
fix: resolved crash on empty input

Submitting Changes

  1. Test your changes — make sure they don’t break existing functionality.

  2. Push your branch

    git push origin my-feature-branch

  3. Create a Pull Request (PR) on GitHub.

  4. Add a clear description of the change and reference any related issues.

Issues & Discussions

  • Bug reports: Include reproduction steps, logs, device info.
  • Feature requests: Describe the use case clearly. UI mockups or references are helpful.
  • Use GitHub Discussions to propose big ideas or architectural changes.

Code of Conduct

Be respectful. Collaborate. Help each other. Don’t spam. We follow a standard code of conduct.

License

By contributing to this project, you agree that your contributions will be licensed under the same license as the project (see LICENSE).

Have fun hacking on Klyx.