contribute-design / contribute-design/examples

Root vs. `.design` folder, clarification

Open
#6 2 comments 2 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
16
Forks
3
PR merge metrics
No merged PRs in 30d

Description

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](https://github.com/owncast/owncast/blob/684e92f/.design/DESIGN.md) (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`).

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.