apple / apple/foundationdb

Define a process for design docs

Open
#1,558 1 comment 1 reaction 0 assignees View on GitHub
Dominant language
C++
Stars
16.7k
Forks
1.6k
Avg merge
1d 20h
Merged PRs (30d)
126

Description

Writing design docs should be encouraged, as a way to discuss the design of a feature before its full implementation, and to provide documentation and history about the change. We currently don’t have anywhere defined to hold design documents, and thus there have been two posted to the forums. We should attempt to solidify what the expectations are around writing design docs, but at minimum, have a place to put them for if/when they are written.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the issue body and the two design documents previously posted to the forums. Define the expectations for writing design docs and choose a durable place to store them. Done means the process and storage location are documented and no longer depend on forum posts.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.