Update CONTRIBUTING.md to enhance development guidelines #600
Conversation
This file contains hidden or 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
Yang-33
reviewed
Jul 14, 2025
CONTRIBUTING.md
Outdated
|
|
||
| ### Install dependencies | ||
|
|
||
| Run `go mod tidy` to install all dependencies for development. |
Contributor
There was a problem hiding this comment.
ok but this library won't use any dependencies, so I think it's not necessary.
Yang-33
reviewed
Jul 14, 2025
CONTRIBUTING.md
Outdated
Comment on lines
21
to
29
| - `/linebot`: The main library code, organized into sub-packages by API functionality. | ||
| - `/examples`: Example projects that demonstrate how to use the library. | ||
| - `/generator`: OpenAPI-based code generation tools and templates. | ||
| - `/script`: Utility scripts for development. | ||
|
|
||
| ### Edit OpenAPI templates | ||
|
|
||
| Almost all code is generated with OpenAPI Generator based on [line-openapi](https://github.com/line/line-openapi)'s YAML files. | ||
| Thus, you cannot edit most code under the `/linebot` directory directly. |
Contributor
There was a problem hiding this comment.
why only this repository uses / prefix?
Contributor
There was a problem hiding this comment.
and can you fix here as follow up for #587?
https://pkg.go.dev/github.com/line/line-bot-sdk-go->https://pkg.go.dev/github.com/line/line-bot-sdk-go/v8
Yang-33
reviewed
Jul 15, 2025
| ### Run your code in your local | ||
|
|
||
| You can use the [example projects](examples) to test your changes locally before submitting a pull request. | ||
|
|
Contributor
There was a problem hiding this comment.
oops, this document should explain we want contributors to write documentation in code.
can you add the section?
Contributor
Author
There was a problem hiding this comment.
Do you mean like this?
Add Documentation section
Contributor
|
LGTM except for one point, thank you! |
Yang-33
approved these changes
Jul 15, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Same as line/line-bot-sdk-php#715