ExportXMLWordPrintableJSON

    • Type: Task
    • Resolution: Unresolved
    • Priority: Unknown
    • None
    • Component/s: Cross Spec Consistency
    • None

      Summary

      The drivers mantras (in "drivers-mantras.md") are outdated and don't reflect the current best-practices. Additionally, keeping them in a separate file makes them difficult to discover. We should update the mantras and move them into CONTRIBUTING.md

      Motivation

      Who is the affected end user?

      Drivers devs.

      How does this affect the end user?

      They are missing up-to-date guidance on what to prioritize when making spec changes.

      How likely is it that this problem or use case will occur?

      Depends on the developer and their familiarity with the mantras. Newer drivers devs are likely less familiar with the mantras.

      If the problem does occur, what are the consequences and how severe are they?

      Unnecessary diagreement and discussion when some people follow the mantras and others aren't aware of them or are confused that they don't reflect our current practices.

      Is this issue urgent?

      No.

      Is this ticket required by a downstream team?

      No.

      Is this ticket only for tests?

      No.

      Acceptance Criteria

      • Update the drivers mantras to reflect our current best practices.
      • Move the mantras from "driver-mantras.md" to CONTRIBUTING.md

            Assignee:
            Unassigned
            Reporter:
            Matt Dale
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated: