Skip to content
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

Merged
merged 2 commits into from
Jun 13, 2022
Merged

Updated maintainer_guide #1225

merged 2 commits into from
Jun 13, 2022

Conversation

WilliamBergamin
Copy link
Contributor

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:

  • Clarified how to initially install the dependencies and run all the unit tests
  • Replaced the python setup.py commands with their corresponding bash script commands
  • Added distinction between the 2 different types of documentation that can be generated

Category (place an x in each of the [ ])

  • slack_sdk.web.WebClient (sync/async) (Web API client)
  • slack_sdk.webhook.WebhookClient (sync/async) (Incoming Webhook, response_url sender)
  • slack_sdk.socket_mode (Socket Mode client)
  • slack_sdk.signature (Request Signature Verifier)
  • slack_sdk.oauth (OAuth Flow Utilities)
  • slack_sdk.models (UI component builders)
  • slack_sdk.scim (SCIM API client)
  • slack_sdk.audit_logs (Audit Logs API client)
  • slack_sdk.rtm_v2 (RTM client)
  • /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)
  • miscellaneous documentation

Requirements (place an x in each [ ])

  • I've read and understood the Contributing Guidelines and have done my best effort to follow them.
  • I've read and agree to the Code of Conduct.
  • I've run python3 -m venv .venv && source .venv/bin/activate && ./scripts/run_validation.sh after making the changes.

@WilliamBergamin WilliamBergamin added the docs M-T: Documentation work only label Jun 10, 2022
@WilliamBergamin WilliamBergamin self-assigned this Jun 10, 2022
@codecov
Copy link

codecov bot commented Jun 10, 2022

Codecov Report

Merging #1225 (573e502) into main (c9dc6aa) will not change coverage.
The diff coverage is n/a.

@@           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.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c9dc6aa...573e502. Read the comment docs.

Copy link
Member

@seratch seratch left a 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!)

.github/maintainers_guide.md Outdated Show resolved Hide resolved
.github/maintainers_guide.md Outdated Show resolved Hide resolved
.github/maintainers_guide.md Outdated Show resolved Hide resolved
.github/maintainers_guide.md Outdated Show resolved Hide resolved
Copy link
Contributor

@filmaj filmaj left a 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!

.github/maintainers_guide.md Outdated Show resolved Hide resolved
.github/maintainers_guide.md Show resolved Hide resolved
Copy link
Contributor

@filmaj filmaj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! :shipit: merge away!

Copy link
Member

@seratch seratch left a 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!

@seratch seratch merged commit 64e6a80 into main Jun 13, 2022
@seratch seratch deleted the WB-guidelines-improvements branch June 13, 2022 21:21
@seratch seratch added this to the 3.17.1 milestone Jun 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs M-T: Documentation work only
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants