SAP / SAP/btp-environment-variable-access

Feat: Shorten Verbose Class Names

Open
#41 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

breaking enhancement
Dominant language
Java
Stars
24
Forks
13
Avg merge
4h 35m
Merged PRs (30d)
5

Description

Context

Many of the public class names are extremely verbose and, thus, very long.
For example:

  • SapServiceOperatorLayeredServiceBindingAccessor
  • SapServiceOperatorServiceBindingIoAccessor
  • SapVcapServicesServiceBindingAccessor

Request

Please shorten these names to increase readability.

Suggestions

  • Consider removing the Sap prefix
  • Consider replacing the ServiceBindingAccessor suffix with just Accessor (in the end: The entire library is just about Service Bindings, so repeating that over and over again might not make too much sense)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No source files or tests are named. Start by locating the three example public classes and all references to them, then determine a consistent shortened naming scheme; done means the public names and their usages are updated without leaving the old names behind.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
backend
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.