AppFlowy-IO / AppFlowy-IO/AppFlowy-Docs

`set up` instead of `setup`

Open Beginner friendly
#193 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
109
Forks
108
PR merge metrics
No merged PRs in 30d

Description

https://github.com/AppFlowy-IO/AppFlowy-Docs/blob/b058a9f9a63da5b2afa4b78f2bbb7c9401c5b9f4/documentation/software-contributions/conventions/git-conventions.md?plain=1#L9

Inaccurate: ....to validate your commit messages when you `setup` your AppFlowy repo.
Accurate: ....to validate your commit messages when you `set up` your AppFlowy repo.

Explanation: `setup` is a noun and `set up` is a verb. In this context it should be a verb.

Contributor guide

No contributing guide indexed for this repository

Research direction

Open documentation/software-contributions/conventions/git-conventions.md and inspect line 9. Change the verb “setup” to “set up” in the sentence about validating commit messages, then review the surrounding text to confirm the correction is clear.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
90/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.