OpenAPITools / OpenAPITools/openapi-generator
[REQ][PHP] Use composerPackageName in Readme.md instead of building from Git info
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
In the generated Readme there are instructions for including the generated package in your project composer.json file (starting on line 22). The repository URL is built using the Git info (host, user ID, repo ID), which makes sense. However, this info is also used to generate the package name in the require section on line 31. This is not ideal as composer package names do not have to match repository names/URLs.
Describe the solution you'd like
By including composerPackageName in my config.json, I can make sure that the package name is correctly added to the generated composer.json file. I think this value should also be used in the Readme.
This could also be used on line 44.
Contributor guide
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 with modules/openapi-generator/src/main/resources/php/README.mustache, focusing on the composer.json instructions around lines 22, 31, and 44. Compare those references with composer.mustache, where composerPackageName is already used. Done means the generated README uses the configured composerPackageName rather than deriving the package name from Git information.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100