apple / apple/foundationdb

Add style guide

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

Description

We should add a style guide so that we can make our code more consistent and easier to read. https://github.com/apple/foundationdb/blob/master/flow/README.md is kind of close to a style guide already, so maybe we can use that.

We should link to it from our PR template: #1559.

Any time we make a style comment on a pull request, we can consider either referencing the style guide or adding to it.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing flow/README.md and the requested PR template change in issue #1559. Identify which existing style guidance is reusable and what project-specific conventions are missing. Done means a proposed style guide is added, linked from the PR template, and its scope is clear enough to reference in future style discussions.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.