search

openedx / open-edx-proposals

Proposals for Open edX architecture, best practices and processes
http://open-edx-proposals.readthedocs.io/
Other
46 stars 32 forks source link

docs: ADR to use React Query instead of Redux, update general JS/TS guidance #616

Closed bradenmacdonald closed 2 months ago

bradenmacdonald commented 3 months ago

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

openedx-webhooks commented 3 months ago

Thanks for the pull request, @bradenmacdonald!

What's next?

Please work through the following steps to get your changes ready for engineering review:

:radio_button: Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

:radio_button: Provide context

To 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:

:radio_button: Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

:radio_button: Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @sarina. Tag them in a comment and let them know that your changes are ready for review.

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:

:bulb: As a result it may take up to several weeks or months to complete a review and merge your PR.

sarina commented 3 months ago

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?

bradenmacdonald commented 3 months ago

Sure. Maybe in both places?

itsjeyd commented 2 months ago

@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.

sarina commented 2 months ago

@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.

bradenmacdonald commented 2 months ago

yeah in both places sounds good.

@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.

bradenmacdonald commented 2 months ago

Thanks everyone!

openedx-webhooks commented 2 months ago

@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.