-
Notifications
You must be signed in to change notification settings - Fork 3
SDKS-4619 Add CONTRIBUTING.md and simplify README.md #170
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| # 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: | ||
| ```sh | ||
| 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: | ||
|
|
||
| ```sh | ||
| ./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: | ||
|
|
||
| - [Android Style Guide](https://github.com/ForgeRock/sdk-standards-of-practice/blob/main/code-style/android-styleguide.md) | ||
| - [Android Security Guidelines](https://github.com/ForgeRock/sdk-standards-of-practice/blob/main/security/security-guidelines-android.md) | ||
|
|
||
| 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: | ||
| ```sh | ||
| 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: | ||
| ```sh | ||
| 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](LICENSE) that covers the project. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.