-
Notifications
You must be signed in to change notification settings - Fork 842
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Updated maintainer_guide #1225
Updated maintainer_guide #1225
Conversation
Codecov Report
@@ Coverage Diff @@
## main #1225 +/- ##
=======================================
Coverage 86.54% 86.54%
=======================================
Files 111 111
Lines 10943 10943
=======================================
Hits 9471 9471
Misses 1472 1472 Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for updating this! Once you resolves my comments, you can merge this PR (don't forget squashing commits into one!)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks pretty good to me, left a couple of comments just to clarify a few final things. Thanks for improving this!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! merge away!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM - thanks for updating this!
Summary
Updated the maintainers guide, this should help developer more clearly understand how to build the project and run the tests. This should also help push the project towards using a bash approach to building and running the test as implemented in the bolt python project.
What was done:
python setup.py
commands with their corresponding bash script commandsCategory (place an
x
in each of the[ ]
)/docs-src
(Documents, have you run./scripts/docs.sh
?)/docs-src-v2
(Documents, have you run./scripts/docs-v2.sh
?)/tutorial
(PythOnBoardingBot tutorial)tests
/integration_tests
(Automated tests for this library)Requirements (place an
x
in each[ ]
)python3 -m venv .venv && source .venv/bin/activate && ./scripts/run_validation.sh
after making the changes.