[Django] Create onboarding documentation for new developers

XMLWordPrintableJSON

    • Type: Task
    • Resolution: Done
    • Priority: Major - P3
    • None
    • Affects Version/s: None
    • Component/s: django
    • None
    • None
    • Python Drivers
    • Hide

      1. What would you like to communicate to the user about this feature?
      2. Would you like the user to see examples of the syntax and/or executable code and its output?
      3. Which versions of the driver/connector does this apply to?

      Show
      1. What would you like to communicate to the user about this feature? 2. Would you like the user to see examples of the syntax and/or executable code and its output? 3. Which versions of the driver/connector does this apply to?
    • None
    • None
    • None
    • None
    • None
    • None

      New developers joining the django-mongodb-backend project lack documentation explaining key concepts and context.

      Create a technical onboarding guide covering:

      • Django upstream — how the backend relates to upstream Django, what we track, and how changes flow in
      • Architecture — overview of the backend structure and key components
      • Extensions — custom Django extensions provided by the backend
      • Workflows — development, testing, and release workflows
      • Testing — how to run the test suite and write new tests
      • Fork — how the Django fork is managed and kept in sync

      The output will be a Google Doc (and potentially a docs page) that can be shared with new contributors and team members.

            Assignee:
            Alex Clark
            Reporter:
            Alex Clark
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: