saveourtool/diktat

Create a good test source for diktat-examples

Open

#560 opened on Nov 20, 2020

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Kotlin (40 forks)github user discovery
good first issue

Repository metrics

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

Description

We probably need to create a good test source for examples: so that users can understand diktat capabilities. Let's create a separate issue for this.

Originally posted by @petertrr in https://github.com/cqfn/diKTat/pull/548#discussion_r527551729

Contributor guide

Research direction
Examine the existing test structure in the diktat repository, understand how examples are currently tested, and design a new test source that demonstrates all major diktat rules. Look at the PR discussion referenced in the issue for context.
Tech stack
kotlin
Domain
testing
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
GitKotlinTesting frameworks
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70