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

Recommendations #3

Open
kedar2a opened this issue Oct 23, 2018 · 1 comment
Open

Recommendations #3

kedar2a opened this issue Oct 23, 2018 · 1 comment
Labels
enhancement New feature or request

Comments

@kedar2a
Copy link

kedar2a commented Oct 23, 2018

Root urls.py

  • Possibly use it as index urls file.
  • Nest other urls based on apps, business logic

Discourse View

  • Break this file into smaller componets, otherwise after a month this will be unmanageable.
  • Remove all static variables, constants to either settings.py or create new file for sitewide configurable vars.
  • Create utils.py python file which will contain pure python classes and methods for processing etc.

General:

  • Follow PEP-8 standards from start. Use pylint which you can configure in any editor.
  • Avoid from <some-module> import *, will make code miserable to troubleshoot issue/bug. This may also leads to cyclic imports.
  • If things are exclusive put it in different files.
    • e.g: Separate file for group, page

  • Avoiod hardcoded values.
    • e.g: {"file":open('/home/siddhu/Desktop/nroer.jpg','rb') }

  • Start doc/ folder at root. Keep adding markdown/org/rst documentation init.
  • Create INSTALL file. Keep documenting sudo level packages that are being getting used.
@gnowgi
Copy link
Member

gnowgi commented Oct 23, 2018

All the above suggestions are bang on.

@gnowgi gnowgi added the enhancement New feature or request label Oct 23, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants