Uploaded image for project: 'Go Driver'
  1. Go Driver
  2. GODRIVER-3180

Document more clearly that "x/" packages are unstable

XMLWordPrintableJSON

    • Type: Icon: Improvement Improvement
    • Resolution: Fixed
    • Priority: Icon: Unknown Unknown
    • 1.16.0
    • Affects Version/s: None
    • Component/s: None
    • None
    • Go Drivers
    • Not Needed
    • 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?

      Context

      The main way we currently notify users that the x/ packages are unstable is using the README in the x/ directory. However, that's easy to miss for many users. Considering the negative impact that breaking changes can have, we should make that warning more obvious to users who only interact with the Go documentation, either through pkg.go.dev or an IDE integration.

      Definition of done

      • Add documentation to all packages in the x/ directory that warns IN BOLD CAPS that the package is experimental and is subject to breaking changes or removal without notice.

      Pitfalls

            Assignee:
            matt.dale@mongodb.com Matt Dale
            Reporter:
            matt.dale@mongodb.com Matt Dale
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: