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

Django Styleguide Survey: Feedback #122

Open
4 of 29 tasks
RadoRado opened this issue Feb 2, 2023 · 5 comments
Open
4 of 29 tasks

Django Styleguide Survey: Feedback #122

RadoRado opened this issue Feb 2, 2023 · 5 comments
Labels
Add an example There's a nice example in the issue / PR that'll enrich the styleguide. Changes to Styleguide Changes to the styleguide required Discussion General discussions Point of View For different points of view on different topics Research Required Research is required

Comments

@RadoRado
Copy link
Member

RadoRado commented Feb 2, 2023

A collection if things to address, based on the feedback from the survey we are running - https://www.hacksoft.io/blog/django-styleguide-survey:

  • Explain why we are approaching this with a service layer & not custom model methods / custom managers & querysets
  • Add reasoning about the lack of ModelViewSet / other DRF generics
  • When to use function-based or class-based services
  • Make it clear, that you can cherry-pick things that you like from this particular styleguide. By no means you should follow it entirely.
  • Explain why we are not following strict REST
  • Working with M2M fields (services, selectors) 🤔
  • pre-commit hooks 🤔
  • Non-API perspective (classic views + templates)
  • Async 🤔
  • Recommend default test runner (pytest)
  • Check https://github.com/kiwicom/pytest-recording / https://github.com/betamaxpy/betamax
  • Add alternative to the "giant test folder" from here - https://github.com/HackSoftware/Django-Styleguide#naming-conventions (test per module, as in JavaScript world)
  • Explain API error formatting better
  • Explain the combination of 12factor app & settings files.
  • Add section about i18n/l10
  • Beginner tutorials - how to get from the official Django tutorial to Django Styleguide
  • Add a dedicated section about signals
  • Add a dedicated section about management commands (for example - doing some kind of data migration outside a data migration)
  • Maybe some tips and tricks about deployment part of Django projects and further support.
  • API versioning
  • Permission Checks / permissions
  • Mention database transactions
  • Mention DX
  • Mention caching / redis
  • Storing and handling constants
  • Dealing with 3rd party services
  • API Schema / Documentation
  • Use better documentation format (PDF, readthedocs, etc.)
  • Mention graphql
@RadoRado
Copy link
Member Author

RadoRado commented Feb 2, 2023

Original issue that was converted to a discussion & now back to an issue - #90

@RadoRado RadoRado added Changes to Styleguide Changes to the styleguide required Discussion General discussions Research Required Research is required Point of View For different points of view on different topics Add an example There's a nice example in the issue / PR that'll enrich the styleguide. labels Feb 2, 2023
@RadoRado
Copy link
Member Author

RadoRado commented Feb 2, 2023

Testing issue comment

@HomaDev
Copy link

HomaDev commented Jan 14, 2024

Can I contribute?
I mean would you consider checking PR, or is this repo for HackSoftware employees only?

@RadoRado
Copy link
Member Author

@HomaDev Yes, we are open for contributions. I just want to manage expectations - if we decide that the contribution does not sit / fit well with the Styleguide, we might just refer it as an option.

Cheers!

@HomaDev
Copy link

HomaDev commented Jan 14, 2024

@RadoRado Thanks!
I'll try to add something worthy

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Add an example There's a nice example in the issue / PR that'll enrich the styleguide. Changes to Styleguide Changes to the styleguide required Discussion General discussions Point of View For different points of view on different topics Research Required Research is required
Projects
None yet
Development

No branches or pull requests

2 participants