Skip to main content
Thank you for your interest in contributing to Android Code Studio! This guide will help you get started with contributing to the project.

​
Ways to Contribute

There are many ways to contribute to Android Code Studio:
  • Report bugs and request features
  • Submit pull requests to fix bugs or add new features
  • Improve documentation
  • Help with translations on Crowdin
  • Help other users in the community

​
Getting Started

1

Fork the Repository

Fork the Android Code Studio repository to your GitHub account.
2

Clone Your Fork

Clone your forked repository to your local machine:
git clone https://github.com/YOUR_USERNAME/android-code-studio.git
cd android-code-studio
3

Set Up Development Environment

Android Code Studio is a Gradle-based Android project that can be built using Android Studio or Android Code Studio itself.
  • Install Android Studio or use Android Code Studio on your Android device
  • Open the project in your IDE
  • Sync Gradle and ensure all dependencies are downloaded
  • Build the project to verify everything is set up correctly
4

Create a Branch

Create a new branch for your changes:
git checkout -b feature/your-feature-name
Use descriptive branch names:
  • feature/ for new features
  • fix/ for bug fixes
  • docs/ for documentation changes
5

Make Your Changes

  • Write clean, maintainable code
  • Follow the existing code style and conventions
  • Test your changes thoroughly
  • Ensure the project builds successfully
6

Commit Your Changes

Write clear, descriptive commit messages:
git add .
git commit -m "Add: Description of your changes"
Good commit message examples:
  • Fix: Crash when opening XML files
  • Add: Support for Kotlin 2.0
  • Improve: Code completion performance
7

Push and Create Pull Request

Push your changes to your fork:
git push origin feature/your-feature-name
Then create a pull request from your fork to the main repository.

​
Pull Request Guidelines

Clear Description

Provide a clear description of what your PR does and why. Reference any related issues.

Single Purpose

Keep PRs focused on a single feature or bug fix. Don’t combine multiple unrelated changes.

Test Your Code

Ensure your changes don’t break existing functionality and test edge cases.

Follow Standards

Follow the project’s coding standards and conventions.

​
Coding Standards

​
General Guidelines

  • Use meaningful variable and function names
  • Add comments for complex logic
  • Keep functions small and focused
  • Follow Android development best practices
  • Ensure code is compatible with Android Gradle Plugin v7.2.0 or newer

​
Code Style

  • Follow standard Kotlin/Java coding conventions
  • Use consistent indentation (project uses spaces)
  • Organize imports properly
  • Remove unused code and imports
Make sure your code builds successfully before submitting a PR. The project must compile without errors.

​
Reporting Bugs

Found a bug? Help us fix it!
1

Check Existing Issues

Search existing issues to see if the bug has already been reported.
2

Create a Bug Report

If the issue doesn’t exist, create a new bug report.
3

Provide Details

Include:
  • Clear description of the bug
  • Steps to reproduce
  • Expected vs actual behavior
  • Android Code Studio version
  • Device information (Android version, device model)
  • Screenshots or logs if applicable

​
Requesting Features

Have an idea for a new feature?
  1. Check if a similar feature request already exists
  2. Create a feature request
  3. Describe the feature and explain why it would be useful
  4. Provide examples of how it would work

​
Translation Contributions

Help make Android Code Studio available in your language! Visit the Crowdin project page to contribute translations.
Translations are managed through Crowdin. Please don’t submit direct PRs for translation files.

​
Community Guidelines

  • Be respectful and constructive
  • Help others in the community
  • Follow the code of conduct
  • Stay on topic in discussions

​
License

By contributing to Android Code Studio, you agree that your contributions will be licensed under the GNU General Public License v3.0 (GPLv3).
Android Code Studio is free software licensed under GPLv3. All contributions must be compatible with this license.

​
Questions?

If you have questions about contributing:
  • Join the Telegram community
  • Ask in GitHub discussions
  • Review existing issues and pull requests
Thank you for contributing to Android Code Studio! Your contributions help make mobile development more accessible to everyone.

Build docs developers (and LLMs) love

Get started for freeTalk to us