Contributing

Thank you for your interest in contributing to the Backtrace Android SDK. Please review the following guidelines to help you get started.

Getting Started

Clone the repository

git clone https://github.com/backtrace-labs/backtrace-android.git

Create a branch - it's good practice to create a new branch for each feature or bugfix, if you have jira ticket put ticket number as branch prefix:
```
git checkout -b jira-ticket/your-feature-name
```

Update submodules

git submodule update --recursive --remote
git submodule update --init --recursive

Code Formatting
- Make sure that your code is properly formatted using the Spotless formatter.
  - From the command line, you can format the code by running:
```
./gradlew spotlessApply
```
  - In Android Studio, you can also use the Spotless Gradle plugin to run formatting directly from the IDE.
Write Tests
- Ensure that you write tests for the new functionality or changes made. This helps maintain the integrity of the project.

Commit Your Changes
- Write clear and concise commit messages. Follow the convention of using the imperative mood in the subject line.
```
git commit -m "Add feature X to improve functionality"
```
Push to the Repository
- Push your changes to the repository:
```
git push origin jira-ticket/your-feature-name
```

Submit a Pull Request
- Go to the repository on GitHub and click on the New Pull Request button.
- Ensure your pull request includes a description of the changes made and references any relevant issues or feature requests.
Review Process
- One of the project maintainers will review your pull request. Please be responsive to any comments or suggestions made.

Ensure that your code follows the existing code style and structure.
Keep your branch up to date with the latest changes from the master branch to avoid merge conflicts.

This project uses Spotless to ensure consistent code style.

Run Spotless check This verifies that your code meets the project’s formatting standards.
```
./gradlew spotlessCheck
```
(Optional) Automatically reformat code If formatting issues are found, you can automatically fix them with:
```
./gradlew spotlessApply   
```