Update CONTRIBUTING.md #730
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Just a few cosmetic fixes to make it easier to follow the doc : * Fixed the link to the generator project * Fixed the link to the modifications.json file * Added the missing command to generate the code
dpash
reviewed
Jun 11, 2024
CONTRIBUTING.md
Outdated
| @@ -69,11 +69,11 @@ Downloaded OpenAPI models are placed in `resources/models/raw/<category>/<api-na | |||
|
|
|||
| A wide variety of refactoring processes are run on the raw schemas to get them ready to be used in the following step: code generation. The refactoring process code is in `SchemaVersion::refactor()`. | |||
|
|
|||
| Certain schema changes need to be made manually, because they are too specific or too cumbersome to make in the code. These modifications are defined in the `resources/modifications.json` file, which is explained more thoroughly [below](#modificationsjson). | |||
| Certain schema changes need to be made manually, because they are too specific or too cumbersome to make in the code. These modifications are defined in the [modifications.json](https://github.com/highsidelabs/saloon-sdk-generator/tree/master/src/resources/metadata/modifications.json) file, which is explained more thoroughly [below](#modificationsjson). | |||
There was a problem hiding this comment.
I think this should be resources/metadata/modifications.json
There was a problem hiding this comment.
Fixed, it is indeed clearer
There was a problem hiding this comment.
Thanks, sorry...copied most of this over from https://github.com/shipstream/fedex-rest-php-sdk since I designed the two libraries very similarly, but missed a couple things
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Just a few cosmetic fixes to make it easier to follow the doc :