openebs-archive/openebsctl

Discussion: Folder Structure revision for openebsctl

Open

#124 opened on Oct 6, 2021

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Go (22 forks)auto 404
good first issue

Repository metrics

Stars
 (33 stars)
PR merge metrics
 (PR metrics pending)

Description

Currently tests and the codebase is written together with their test_data all in one folder making it hard dig through the files and folders once it starts to mature. Can we think of making a parent folder with e2e tests written like:

|-cmd
|-tests
|-pkg

or we can think of writing tests within the same package that we are doing now, but extract out all the test resources in their own folder named like tests

|-cmd
 `|-client
   `|-test
     `|-test.go
      |-test_data.go
   `|k8s.go

Contributor guide

Research direction
Examine the current folder layout of the repository, identify test files and test data, and propose a revised structure that separates test resources from code. Consider contributing a PR with the new structure if agreed upon.
Tech stack
go
Domain
backendcli
Issue type
Refactor
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.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Go
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70