Skip to content

docs(contributing): update JDK requirement and KDoc URLs #2241

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

Open
RohithPariki wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(contributing): update JDK requirement and KDoc URLs #2241

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions catalog/src/main/kotlin/com/adevinta/spark/catalog/util/Url.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,13 @@ public const val GuidelinesUrl: String = "https://spark.adevinta.com"
public const val ComponentGuidelinesUrl: String = "https://spark.adevinta.com/1186e1705"
public const val StyleGuidelinesUrl: String = "https://m3.material.io/styles"
public const val ReleasesUrl: String = "https://github.com/leboncoin/spark-android/releases"
public const val DocsUrl: String = "https://adevinta.github.io/spark-android"
public const val DocsUrl: String = "https://leboncoin.github.io/spark-android"
public const val SourceUrl: String = "https://github.com/leboncoin/spark-android"
public const val SparkSourceUrl: String = "https://github.com/leboncoin/spark-android/tree/main/spark/src/main"

public const val SampleSourceUrl: String = "https://github.com/leboncoin/spark-android/blob/main/catalog/src/main/kotlin/com/adevinta/spark/catalog/examples/samples"

public const val PackageSummaryUrl: String = "https://adevinta.github.io/spark-android/spark"
public const val PackageSummaryUrl: String = "https://leboncoin.github.io/spark-android/spark"

public const val IssueUrl: String = "https://github.com/leboncoin/spark-android/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc"
public const val LicensesUrl: String = "https://github.com/leboncoin/spark-android/blob/main/LICENSE"
13 changes: 5 additions & 8 deletions docs/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,21 +93,18 @@ Configure your development environment for Spark Android development. This secti
git lfs install
```

4. **[Java 17](https://github.com/leboncoin/spark-android/issues/74)**
4. **Java Development Kit (JDK)**

We currently use a version of AGP which requires developers to use **JDK 17** on Gradle JDK.
**JDK 17 or later** is required to build the project and run the Gradle daemon.

_If you're on macOS, you can install it with [brew](https://formulae.brew.sh/formula/openjdk@17)_
_If you're on macOS, you can install it with [Homebrew](https://formulae.brew.sh/formula/openjdk@17)_:

```bash
brew install openjdk@17
```

> ℹ️ If you're using a device with [Apple silicon (M1/M2)](https://support.apple.com/en-us/HT211814) then you might need to install
> a [zulu distribution](https://www.azul.com/downloads/zulu-community/?version=java-17-lts&architecture=x86-64-bit&package=jdk)

Alternatively, install it directly from **Android Studio**:
`File` → `Settings` → `Build, Execution, Deployment` → `Build Tools` → `Gradle` → `Gradle JDK`
Alternatively, configure or download it directly from **Android Studio**:
`Settings` → `Build, Execution, Deployment` → `Build Tools` → `Gradle` → `Gradle JDK`

---

Expand Down