-
Notifications
You must be signed in to change notification settings - Fork 34
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
docs: ADR to use React Query instead of Redux, update general JS/TS guidance #616
Conversation
Thanks for the pull request, @bradenmacdonald! What's next?Please work through the following steps to get your changes ready for engineering review: 🔘 Get product approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:
🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. 🔘 Let us know that your PR is ready for review:Who will review my changes?This repository is currently maintained by Where can I find more information?If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:
When can I expect my changes to be merged?Our goal is to get community contributions seen and reviewed as efficiently as possible. However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
It would be great to have something in this tree, I think: https://docs.openedx.org/en/latest/developers/references/developer_guide/conventions/index.html that points to this OEP. Or maybe there's a better place within https://docs.openedx.org/en/latest/developers/references/developer_guide/index.html? What do you think? |
Sure. Maybe in both places? |
@sarina It looks like you already started reviewing this PR, so I went ahead and assigned the review to you. Let me know if that's not what you had in mind. |
@bradenmacdonald yeah in both places sounds good. @itsjeyd - I am the maintainer of this repo so I commented a bit on structure, but I'm not a frontend expert so Braden should seek to find a reviewer from that group. |
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.
This looks great! I'm 100% on board with recommending React Query, and the reasoning provided here is clear and persuasive.
I left one tiny non-blocking comment, but LGTM!
@sarina Since those are in a different repo, I'll open a PR to link to this from both places once this PR has merged. I think this should be good to merge soon, but I've posted on Slack one last time to see if anyone else wants to comment/review. |
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.
100%.
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.
Glad to see React Query make its way into the OEPs :)
Thanks everyone! |
@bradenmacdonald 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future. |
Previous discussions etc:
Preview this at https://open-edx-proposals--616.org.readthedocs.build/en/616/best-practices/oep-0067-bp-tools-and-technology.html