Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
58 lines (40 loc) · 2.42 KB

CONTRIBUTING.md

File metadata and controls

58 lines (40 loc) · 2.42 KB

Contributing to the Ping Identity Android SDK

First off, thank you for considering contributing to the Ping Identity Android SDK! We appreciate your time and effort.

This document outlines the guidelines for contributing to this project. Please take a moment to review it before you get started.

Getting Started

  1. Fork the repository on GitHub.
  2. Clone your fork locally: 
    git clone https://github.com/YOUR_USERNAME/ping-android-sdk.git
  3. Open the project in Android Studio. The project uses Gradle, so dependencies will be automatically resolved when you open it.

Building and Testing

Before submitting any changes, please ensure that you can build the project and that all tests pass.

To run all unit tests, execute the following command from the root of the project:

./gradlew --rerun-tasks testDebugUnitTestCoverage --stacktrace --no-daemon

Ensure that all existing tests pass and that you add new tests for any new functionality you introduce.

Standard of Practice

This project follows the internal standards of practice maintained by the Ping Identity SDK team. Please review and adhere to these guidelines before submitting any code:

In general, try to match the style of the existing code in the project.

Submitting a Pull Request

  1. Create a new branch for your feature or bug fix: 
    git checkout -b your-feature-branch
  2. Make your changes and commit them with a clear and concise message.
  3. Ensure all tests pass.
  4. Push your branch to your fork: 
    git push origin your-feature-branch
  5. Open a Pull Request to the develop branch of the original repository.
  6. In your Pull Request, please follow the template provided. This includes:
    • Linking to a JIRA ticket if applicable.
    • Providing a clear description and justification of the changes you have made.

Your pull request will be reviewed by the project maintainers. You may be asked to make changes before your PR is merged.

License

By contributing to the Ping Identity Android SDK, you agree that your contributions will be licensed under the MIT License that covers the project.