Docs: Expand CONTRIBUTING.md with step-by-step local development setup

Open Beginner friendly
  • Is something wrong?
#14 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 2 days

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
78/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
android, kotlin
Domain
documentation

Research direction

Read the existing CONTRIBUTING.md and check the Gradle tasks named in the issue: ./gradlew test and ./gradlew :composeApp:run. Expand the guide with Temurin JDK 21, recommended Android Studio and IntelliJ IDEA plugins, local test and desktop launch steps, and code style and Git commit conventions; done when each requested setup step is documented.

Written by the indexing model from the issue text.

Description

documentation good first issue
Summary

Improve the developer onboarding experience by expanding CONTRIBUTING.md with:

  • Required JDK versions (Temurin JDK 21).
  • Recommended IDE plugins for Android Studio & IntelliJ IDEA.
  • How to run multiplatform unit tests (./gradlew test).
  • How to launch Compose Desktop locally (./gradlew :composeApp:run).
  • Code style & Git commit conventions.
Dominant language
Kotlin
Stars
1
Forks
0
Avg merge
25m
Merged PRs (30d)
2

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from developmentwithyash/yaan

All issues in developmentwithyash/yaan

Similar issues

More Kotlin issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.