Skip to content

Root vs. .design folder, clarification #6

@mrienstra

Description

@mrienstra

Hi! Neat project!

Two questions:

  1. Do you discourage usage of .design/DESIGN.md (or .design/README.md) when following the "minimal" guidelines? Just curious, the first project I looked at (from the collection at https://contribute.design/projects) is using .design/DESIGN.md.
  2. Do you discourage usage of a root DESIGN.md (in place of .design/README.md, with other files remaining nested in .design) when following the "Extended" or "Full Fledged" guidelines? This pattern seems more "discoverable" for designers who may be unaware of contribute.design, and are encountering an open source project organically.

One suggestion: a lot of projects use a root CONTRIBUTING.md to bring new contributors up to speed / document best practices for contributors. Guessing most implementors (of your guidelines) will think of this, but maybe this repo should suggest adding a link from CONTRIBUTING.md to DESIGN.md (or .design/README.md).

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions