-
Notifications
You must be signed in to change notification settings - Fork 835
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
chore: small maintainer guidelines #1529
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1529 +/- ##
=======================================
Coverage 84.96% 84.96%
=======================================
Files 113 113
Lines 12498 12498
=======================================
Hits 10619 10619
Misses 1879 1879 ☔ View full report in Codecov by Sentry. |
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.
Thank you for organizing this!
.github/pull_request_template.md
Outdated
@@ -13,12 +17,11 @@ | |||
- [ ] **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`?) | |||
- [ ] `/docs-src` (Documents, have you run `./scripts/docs.sh`/`./scripts/generate_api_docs.sh`?) |
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.
The ./scripts/generate_api_docs.sh
does not use docs-src files at all. Thus, this sounds a bit incorrect. Also, most contributors apart from us never use it. Adding the step to run this script to the maintainer guide section may be better.
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.
I see, I've removed the reference to ./scripts/generate_api_docs.sh
, let me know what you think
Summary
This PR improve the release instructions and updates the pull request template
Category (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.