Contributing to Pulsator4Droid

Contributions are welcome! If you'd like to help improve the library, please follow these guidelines.

Development Setup

Fork the repository on GitHub.

Clone your fork to your local machine:

git clone https://github.com/USERNAME/Pulsator4Droid.git

Open the project in Android Studio.
The project uses the Gradle wrapper, so you can build it from the command line or directly from the IDE.

Building and Testing

You can build the entire project, including the library and the demo app, by running the following command from the project root:

./gradlew build

The demo module is a sample application that provides an easy way to visually test your changes. You can install it on an emulator or a physical device.

Code Quality Checks

The project is configured with several code quality tools to maintain a high standard of code. These checks are run automatically by our Continuous Integration (CI) setup on Travis CI.

To run the checks locally before committing, use the following command:

./gradlew check

This command executes:

Checkstyle: Enforces a consistent coding style. Configuration is located at config/quality/checkstyle/checkstyle-config.xml.
FindBugs: Performs static analysis to find potential bugs in the Java bytecode.
PMD: Inspects the source code for common programming flaws.

Pull requests must pass all quality checks to be merged.

Submitting a Pull Request

Create a new branch for your feature or bug fix:
```
git checkout -b my-awesome-feature
```
Make your changes and commit them with a clear, descriptive message.
Push your branch to your fork on GitHub:
```
git push origin my-awesome-feature
```
Open a Pull Request from your fork to the master branch of the original repository.
Provide a detailed description of your changes in the pull request.