Skip to content
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

Update Technology Recommendations and Related Decisions #531

Open
7 tasks
feanil opened this issue Oct 16, 2023 · 4 comments
Open
7 tasks

Update Technology Recommendations and Related Decisions #531

feanil opened this issue Oct 16, 2023 · 4 comments
Labels
help wanted Ready to be picked up by anyone in the community

Comments

@feanil
Copy link
Contributor

feanil commented Oct 16, 2023

OEP-67 recommendations that need to be reviewed and potentially updated.

Updates to existing recommendations

  • Codecov is generally recommended not just recommended for the frontend, add a new overall ADR to reflect this general recommendation.

Historic Standards that need notes and ADRs

  • Django
  • DRF
  • drf-yasg
  • tox
  • pytest
  • edx-lint

Related: Frontend changes

#524
#480

@sarina sarina added the help wanted Ready to be picked up by anyone in the community label May 17, 2024
@sarina
Copy link
Contributor

sarina commented May 17, 2024

@feanil in order to facilitate me finding some people to help out with this, is there any more detail you could add around the "Historic Standards"? I'm not sure how anyone would write ADRs for some of the basic ones like Django. And does edx-lint not have some stuff existing about why it was created?

@sarina sarina added the waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. label May 17, 2024
@feanil
Copy link
Contributor Author

feanil commented May 20, 2024

Many of the de-facto technologies don't have a lot of history about why they were picked. I think the why they were chosen over other things is less important than summarizing that we have chosen these things and that they are the current standard for this project. For example, we don't need the summary for Django to justify Django as much as we need it to acknowledge and codify that "By default any backend webserver that interacts with databases in the Open edX project, should use Django as the framework. Django has a lot of reasonable defaults and security capabilities built in and the community is already familiar with it, currently we are not looking to add other technologies as alternatives to Django for backend webservers."

@sarina
Copy link
Contributor

sarina commented May 21, 2024

OK, that makes sense. This feels like a ticket many people could pick up a part of, I'll edit the description to be checkboxes.

@sarina sarina removed the waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. label May 21, 2024
@sarina
Copy link
Contributor

sarina commented Jul 5, 2024

To anyone picking this up: I suspect we should hold off on expanding a Codecov recommendation until we figure out if Codecov remains the best tool for the job (recent changes in Codecov has made it a less reliable service)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Ready to be picked up by anyone in the community
Projects
None yet
Development

No branches or pull requests

2 participants