avast/gradle-docker-compose-plugin

Use the same naming convention for services, volumes and networks

Open

#441 opened on May 13, 2024

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Groovy (103 forks)batch import
help wanted

Repository metrics

Stars
 (429 stars)
PR merge metrics
 (Avg merge 24d 11h) (2 merged PRs in 30d)

Description

Hi all, It's just an advice. I've noticed that the naming convention is different between services and volumes. the services are named using hyphen (ex. {projectName}-{serviceName}) while volumes and networks are using underscore.

IMHO it's better to use the same, hyphen is much better.

Contributor guide

Research direction
Identify all places in the codebase where services, volumes, and networks are named, then propose a consistent naming convention using hyphens.
Tech stack
groovydocker
Domain
devopsbuild system
Issue type
Chore
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.
Under 1 hour
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
GitGradleDocker Compose
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90