LibertyDSNP / spec

The DSNP Spec and Website
https://spec.dsnp.org
Other
31 stars 3 forks source link

[DO NOT MERGE] design document document first pass #134

Closed shannonwells closed 2 years ago

shannonwells commented 2 years ago

DO NOT MERGE

This is just in the spec repo for review. A DesignDocs repo will be created and this will be the README.

Problem

We want to create Design Documents for publication in our repo. We need to create a process for generating Design Documents. We need to describe how to write the Design Documents.

Solution

Write a Design Document meta-document.

Tasks

with @raebot and @sstruble

Change summary:

sstruble commented 2 years ago

@shannonwells @kfogel and I created a new "meta" repository for guidelines that should apply across the entire project. I'm just starting to populate it, but when the team thinks this Design Doc is in good enough shape, I suggest that meta repo as a good landing place.

shannonwells commented 2 years ago

Good idea. Okay so we put this above into there, and then Design Docs relating to given repos go into the related repo. That helps draw a better dividing line between Spec changes (such as DIPs) and Design Docs. I guess we can also put PR templates in there too.

sstruble commented 2 years ago

@shannonwells It might be easiest to just use GitHub's PR templates - revised, if required, for our needs - and point out in our contributing.md that we follow these automatically populate conventions. @kfogel might have a thought here on the best approach

shannonwells commented 2 years ago

Closing this and moving this to a PR against meta.