ExportXMLWordPrintableJSON

    • Type: Task
    • Resolution: Done
    • Priority: Major - P3
    • None
    • Affects Version/s: None
    • Component/s: Infrastructure
    • 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

      Context

      Our changelog entries don't follow a documented style. Contributors currently guess at tense, wording, and formatting, which leads to inconsistent entries across drivers and over time.

      Definition of done

      A written style guide based on "Keep a Changelog" (https://keepachangelog.com) exists for changelog entries that defines tense, voice, level of detail, how to reference tickets/PRs, date format, ordering, etc.

      This style guide should be added to our CONTRIBUTING.md and titled "Changelog Standards"

      Pitfalls

      Agreeing on the contents of the guide and where to publish the guide.

            Assignee:
            Noah Stapp
            Reporter:
            Alex Clark
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Created:
              Updated:
              Resolved: