Skip to content
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.

Sign up for GitHub

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

Add Contributing section to README #128

Merged
merged 2 commits into from
Dec 18, 2024
Merged

Add Contributing section to README #128

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8f4de39
Add Contributing section to README with githook setup
alexshikov Dec 18, 2024
bc2e475
Fix typo in the README
alexshikov Dec 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 22 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Virtusize Android Integration

[![](https://jitpack.io/v/virtusize/integration_android.svg)](https://jitpack.io/#virtusize/integration_android) [![](https://img.shields.io/maven-central/v/com.virtusize.android/virtusize)](https://search.maven.org/search?q=g:%22com.virtusize.android%22%20AND%20a:%22virtusize%22)
[![](https://jitpack.io/v/virtusize/integration_android.svg)](https://jitpack.io/#virtusize/integration_android) [![](https://img.shields.io/maven-central/v/com.virtusize.android/virtusize)](https://central.sonatype.com/artifact/com.virtusize.android/virtusize)

[日本語](https://github.com/virtusize/integration_android/blob/master/README-JP.md)

Expand Down Expand Up @@ -59,6 +59,8 @@ customers. [Contact our sales team](mailto:sales@virtusize.com) to become a cust

- [Examples](#examples)

- [Contributing](#contributing)

- [License](#license)

## Requirements
Expand Down Expand Up @@ -857,6 +859,25 @@ Use the [Virtusize Auth SDK](https://github.com/virtusize/virtusize_auth_android
1. Kotlin example https://github.com/virtusize/integration_android/tree/master/sampleAppKotlin
2. Java example https://github.com/virtusize/integration_android/tree/master/sampleAppJava

## Contributing

### Linter

We use [ktlint](https://github.com/pinterest/ktlint?tab=readme-ov-file) for formatting. Run linter check or format when needed:
```sh
./gradlew ktlint
./gradlew ktlintFormat
```

### Git Hooks

Ensure to setup the `pre-push` git hooks after cloning the repo.
Git hook will run `ktlint` and tests on every push automatically.
```sh
./gradlew installGitHooks
```


## License

Copyright (c) 2018-24 Virtusize CO LTD (https://www.virtusize.jp)
4 changes: 2 additions & 2 deletions gradle/wrapper/gradle-wrapper.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#Sat Aug 03 17:16:17 JST 2024
#Wed Dec 18 11:23:11 GMT 2024
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-8.7-bin.zip
distributionUrl=https\://services.gradle.org/distributions/gradle-8.11.1-bin.zip
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
Loading