Android - Development Workflow
This section contains comprehensive guides for developing and releasing Q2 Mobile SDK modules on Android. These guides walk you through the entire journey from initial development to production release.
Getting Started
If you're new to Q2 Mobile SDK development, start here:
- Local Development - Learn the day-to-day development workflow
- Development Workflow - Understand the complete end-to-end process
- Submitting Support Tickets - Learn how to submit merge requests and tickets
Workflow Guides
Local Development
A detailed guide for day-to-day module development:
- Creating feature branches
- Developing and testing with DevApp
- Testing with ProGuard/R8 obfuscation
- Preparing for merge requests
Use this guide when: You're actively writing code and need to understand best practices for local development and testing.
Development Workflow
A comprehensive overview of the complete development and release process:
- Visual workflow diagram
- Step-by-step process from development to production
- What partners/FIs do vs. what Q2 does
- Detailed explanations of each phase
Use this guide when: You want to understand the big picture of how modules move from development to production.
Submitting Support Tickets
Detailed instructions for submitting tickets through q2developer.com:
- When and how to submit tickets
- Ticket templates and examples
- Required information for different ticket types
- Best practices and FAQs
Use this guide when: You're ready to submit a merge request or need to contact Q2 support.
Consumer ProGuard Rules
Essential guide for creating and testing ProGuard/R8 consumer rules:
- Why consumer rules are critical for production builds
- How to create specific keep rules
- Testing with minify enabled
- Common issues and solutions
- Rules that will be rejected during code review
Use this guide when: Preparing your module for production (required for all modules).
Third-Party Libraries
Guide for submitting private third-party libraries to Q2 for hosting:
- When you need to submit libraries
- How to prepare library artifacts (.aar and .pom files)
- POM file format requirements
- Submission process
Use this guide when: Your module uses private or non-standard Maven libraries.
Related Documentation
Publishing
- Code Review Process - What Q2 reviews during merge requests
- Android Publishing Overview - High-level publishing information
Setup and Configuration
- Environment Setup - Initial development environment setup
- DevApp Setup - Setting up the Q2DevApp
- Settings JSON - Configuring your module
Module Development
- Creating Modules - Module types and how to create them
- Consumer ProGuard Rules - Essential for production builds
Debugging
- Module Debugging - Debugging tools and techniques
Quick Reference
The Complete Flow
- Develop locally → Create branch, write code, test with DevApp
- Test obfuscation → Enable minify, test with R8/ProGuard
- Submit for review → Create MR, submit support ticket
- Q2 reviews → Security and safety review
- Test build → Q2 creates test build, you validate
- Deploy to production → Submit deployment request, Q2 releases
Key Reminders
- Always branch from
master - Test with minify enabled before submitting
- Include module data configuration changes in tickets
- settings.json from DevApp is not automatically copied to test/production builds
- Q2 reviews for security and safety, not code quality
Ready to start developing? Begin with Local Development.