opentracing-contrib / opentracing-contrib/java-spring-cloud
Rename artifacts/package
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 399
- Forks
- 143
- Avg merge
- 1d 3h
- Merged PRs (30d)
- 22
Description
Follow Spring starter naming conventions
at the moment artifacts are named opentracing-spring-cloud-<module>-starter, however spring uses convention spring-boot-starter-<module>
https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#using-boot-starter
Although it's spring convention, the docs shows an example like acme-spring-boot-starter.
Rename from opentracing-spring-cloud to something else
This project is a collection of instrumentation for Spring Boot. Spring Cloud seems to be as a subset to spring boot. It anyways depends on SB.
I have a couple of proposals:
opentracing-spring-boot-this is my preferredopentracing-spring-k
The rename will break users - groupId but also we should change package and configuration https://github.com/opentracing-contrib/java-spring-cloud/blob/master/instrument-starters/opentracing-spring-cloud-core/src/main/resources/META-INF/additional-spring-configuration-metadata.json#L4
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by inventorying artifacts under instrument-starters, including opentracing-spring-cloud-core, and inspect additional-spring-configuration-metadata.json. Review the Spring Boot starter naming guidance and determine the complete impact on artifact names, groupId, packages, and configuration; done means the naming is consistently migrated with the breaking changes accounted for.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, spring-boot
- Domain
- backend, build-system
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100