pedrovgs/KotlinSnapshot

Dev Documentation > File Structure

Open

#65 opened on Sep 20, 2020

View on GitHubContributor guide
 (1 comment) (0 reactions) (0 assignees)Kotlin (13 forks)github user discovery
enhancementhelp wanted

Repository metrics

Stars
 (167 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

As a new developer contributing, it's hard to follow how the duplicate folder structure

For example, whats the difference between:

this file in /src/main and this file in core/bin ????

Let's add markdown documentation for this.

Contributor guide

Research direction
Examine the duplicate file structure in the repository and create a markdown documentation file explaining the purpose of each directory, particularly the 'core/src/main' and 'core/bin' directories.
Tech stack
kotlin
Domain
documentationtesting
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85