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.

Sign up for GitHub

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

Jump to bottom

New App Checklist #230

Open
9 tasks
ormsbee opened this issue Sep 19, 2024 · 0 comments
Open
9 tasks

New App Checklist #230

ormsbee opened this issue Sep 19, 2024 · 0 comments

Comments

@ormsbee
Copy link
Contributor

ormsbee commented Sep 19, 2024

Need to write a doc of things so we don't forget. Should mention

  • import linter
  • model conventions
  • private API conventions
  • public API conventions
  • preferred way to make tests
  • places where we deviate from OEP-49 (particularly how we pass around querysets)
  • philosophy on small apps that encapsulate discrete pieces of functionality
  • philosophy on extensible models
  • boundaries we want to enforce (e.g. leaving authorization out)

(other folks please feel free to add stuff)
ormsbee added a commit to ormsbee/openedx-learning that referenced this issue Sep 19, 2024
@ormsbee
test: add collections app to import linter config
527b78c 
All new apps should have an entry in the .importlinter config file so
that our internal dependency tree stays clean, but we don't actually
document that anywhere yet.

Made openedx#230 to track
work around making a "new app" checklist doc to help with this sort of
thing in the future.
@ormsbee ormsbee mentioned this issue Sep 19, 2024
Merged
ormsbee added a commit that referenced this issue Sep 19, 2024
@ormsbee
test: add collections app to import linter config
8ae750e 
All new apps should have an entry in the .importlinter config file so
that our internal dependency tree stays clean, but we don't actually
document that anywhere yet.

Made #230 to track
work around making a "new app" checklist doc to help with this sort of
thing in the future.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@ormsbee