chore: small maintainer guidelines #1529
Merged
+22
−8
Conversation
This file contains 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
WilliamBergamin
changed the title
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. |
seratch
requested changes
Jul 5, 2024
.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.
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.
I see, I've removed the reference to ./scripts/generate_api_docs.sh, let me know what you think
seratch
approved these changes
Jul 7, 2024
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.
Summary
This PR improve the release instructions and updates the pull request template
Category (place an
xin 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
xin each[ ])python3 -m venv .venv && source .venv/bin/activate && ./scripts/run_validation.shafter making the changes.