You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@superset.apache.org by "john-bodley (via GitHub)" <gi...@apache.org> on 2023/06/20 05:15:32 UTC
[GitHub] [superset] john-bodley opened a new pull request, #24451: docs: Add tips regarding authoring DAOs
john-bodley opened a new pull request, #24451:
URL: https://github.com/apache/superset/pull/24451
<!---
Please write the PR title following the conventions at https://www.conventionalcommits.org/en/v1.0.0/
Example:
fix(dashboard): load charts correctly
-->
### SUMMARY
In https://github.com/apache/superset/pull/24331 (as part of [SIP-92 Proposal for restructuring the Python code base](https://github.com/apache/superset/issues/20630)) I organized the DAOs into a single folder. This highlighted a number of inconsistencies and shortcomings (an expected outcome from centralization) and thus I thought there would be merit if we explicitly mentioned how DAOs should be defined to help improve the code quality and developer experience.
I've enumerated a few ideas I had, but any additional suggestions are welcome. Note I plan to create a number of followup PRs which should ensure that the current DAOs adhere to these rules.
### BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF
<!--- Skip this if not applicable -->
### TESTING INSTRUCTIONS
CI.
### ADDITIONAL INFORMATION
<!--- Check any relevant boxes with "x" -->
<!--- HINT: Include "Fixes #nnn" if you are fixing an existing issue -->
- [ ] Has associated issue:
- [ ] Required feature flags:
- [ ] Changes UI
- [ ] Includes DB Migration (follow approval process in [SIP-59](https://github.com/apache/superset/issues/13351))
- [ ] Migration is atomic, supports rollback & is backwards-compatible
- [ ] Confirm DB migration upgrade and downgrade tested
- [ ] Runtime estimates and downtime expectations provided
- [ ] Introduces new feature or API
- [ ] Removes existing feature or API
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
[GitHub] [superset] john-bodley closed pull request #24451: docs: Add tips regarding authoring DAOs
Posted by "john-bodley (via GitHub)" <gi...@apache.org>.
john-bodley closed pull request #24451: docs: Add tips regarding authoring DAOs
URL: https://github.com/apache/superset/pull/24451
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
[GitHub] [superset] codecov[bot] commented on pull request #24451: docs: Add tips regarding authoring DAOs
Posted by "codecov[bot] (via GitHub)" <gi...@apache.org>.
codecov[bot] commented on PR #24451:
URL: https://github.com/apache/superset/pull/24451#issuecomment-1598133638
## [Codecov](https://app.codecov.io/gh/apache/superset/pull/24451?src=pr&el=h1&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) Report
> Merging [#24451](https://app.codecov.io/gh/apache/superset/pull/24451?src=pr&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) (012fe60) into [master](https://app.codecov.io/gh/apache/superset/commit/3e76736874f5a7b1ca35a9f3b13cbb4bc3791f69?el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) (3e76736) will **decrease** coverage by `10.91%`.
> The diff coverage is `n/a`.
```diff
@@ Coverage Diff @@
## master #24451 +/- ##
===========================================
- Coverage 68.91% 58.01% -10.91%
===========================================
Files 1899 1899
Lines 73843 73843
Branches 8119 8119
===========================================
- Hits 50892 42840 -8052
- Misses 20840 28892 +8052
Partials 2111 2111
```
| Flag | Coverage Δ | |
|---|---|---|
| hive | `?` | |
| mysql | `?` | |
| postgres | `?` | |
| presto | `53.81% <ø> (ø)` | |
| python | `60.57% <ø> (-22.75%)` | :arrow_down: |
| sqlite | `?` | |
| unit | `54.60% <ø> (ø)` | |
Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache#carryforward-flags-in-the-pull-request-comment) to find out more.
[see 299 files with indirect coverage changes](https://app.codecov.io/gh/apache/superset/pull/24451/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache)
:mega: We’re building smart automated test selection to slash your CI/CD build times. [Learn more](https://about.codecov.io/iterative-testing/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
[GitHub] [superset] michael-s-molina commented on pull request #24451: docs: Add tips regarding authoring DAOs
Posted by "michael-s-molina (via GitHub)" <gi...@apache.org>.
michael-s-molina commented on PR #24451:
URL: https://github.com/apache/superset/pull/24451#issuecomment-1598634671
@john-bodley I really like the initiative but I think the best place for this content would be a Wiki page. As you can see [here](https://github.com/apache/superset/wiki), we have guidelines for the frontend and backend. I think this could be a sub-page of [Backend Style Guidelines](https://github.com/apache/superset/wiki/Backend-Style-Guidelines) 😉
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
[GitHub] [superset] john-bodley commented on pull request #24451: docs: Add tips regarding authoring DAOs
Posted by "john-bodley (via GitHub)" <gi...@apache.org>.
john-bodley commented on PR #24451:
URL: https://github.com/apache/superset/pull/24451#issuecomment-1598931376
Closing in favor of @michael-s-molina's suggestion. Please feel free to edit [this](https://github.com/apache/superset/wiki/DAO-Style-Guidelines-and-Best-Practices) wiki page with any updates.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org