docs: Add tips regarding authoring DAOs#24451
Closed
john-bodley wants to merge 1 commit into
Closed
Conversation
john-bodley
requested review from
betodealmeida,
dpgaspar,
hughhhh,
michael-s-molina and
villebro
Codecov Report
@@ Coverage Diff @@
## master #24451 +/- ##
=======================================
Coverage 68.91% 68.91%
=======================================
Files 1899 1899
Lines 73843 73843
Branches 8119 8119
=======================================
Hits 50892 50892
Misses 20840 20840
Partials 2111 2111
Flags with carried forward coverage won't be shown. Click here to find out more. 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
Member
|
@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, we have guidelines for the frontend and backend. I think this could be a sub-page of Backend Style Guidelines 😉 |
Member
Author
|
Closing in favor of @michael-s-molina's suggestion. Please feel free to edit this wiki page with any updates. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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
In #24331 (as part of SIP-92 Proposal for restructuring the Python code base) 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 in CONTRIBUTING.md 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
TESTING INSTRUCTIONS
CI.
ADDITIONAL INFORMATION