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 (429 stars) (103 forks)batch import
help wanted

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

Tech stack
groovydocker
Domain
devops
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.
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.
mostly clear
Prerequisites
Knowledge of GroovyDocker Compose
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Investigate the naming logic in the plugin's source code, likely in the configuration extensions for services, volumes, and networks. Consider renaming volume and network names from underscore to hyphen to match service naming convention. Request maintainer feedback on the desired approach and any potential breaking changes via the issue (https://github.com/avast/gradle docker compose plugin/issues/441). The single comment may provide additional context.