Update CONTRIBUTING.md to enhance development guidelines #824
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
eucyt
commented
Jul 14, 2025
Comment on lines
-379
to
-435
| For SDK developers | ||
| ------------------ | ||
|
|
||
| First install for development. | ||
|
|
||
| :: | ||
|
|
||
| $ pip install -r requirements-dev.txt | ||
|
|
||
|
|
||
| You can generate new or fixed models and APIs by this command. | ||
|
|
||
| :: | ||
|
|
||
| $ python generate-code.py | ||
|
|
||
|
|
||
| When you update line-bot-sdk-python version, please update `linebot/__about__.py <linebot/__about__.py>`__ and generate code again. | ||
|
|
||
|
|
||
| If you edit `README.rst <README.rst>`__, you should execute the following command to check the syntax of README. | ||
|
|
||
| :: | ||
|
|
||
| $ python -m readme_renderer README.rst | ||
|
|
||
|
|
||
| Run tests | ||
| ~~~~~~~~~ | ||
|
|
||
| Test by using tox. We test against the following versions. | ||
|
|
||
| - 3.9 | ||
| - 3.10 | ||
| - 3.11 | ||
| - 3.12 | ||
| - 3.13 | ||
|
|
||
| To run all tests and to run ``flake8`` against all versions, use: | ||
|
|
||
| :: | ||
|
|
||
| tox | ||
|
|
||
| To run all tests against version 3.10, use: | ||
|
|
||
| :: | ||
|
|
||
| $ tox -e py3.10 | ||
|
|
||
| To run a test against version 3.10 and against a specific file, use: | ||
|
|
||
| :: | ||
|
|
||
| $ tox -e py3.10 -- tests/test_webhook.py | ||
|
|
||
|
|
There was a problem hiding this comment.
It will be excluded as it duplicates the content of CONTRIBUTING.md. Since there is already a link to CONTRIBUTING.md, it is unnecessary.
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.
Same as line/line-bot-sdk-php#715