Skip to content

Recommendations #3

@kedar2a

Description

@kedar2a

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions