Skip to content

Commit ef694d7

Browse files
committed
Document git identity setup
This is well known but it does not hurt to briefly mention it in any case.
1 parent aeff9bb commit ef694d7

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@ runtime repository and submits changes using [pull requests]. Contributions
77
must pass continuous integration checks and review by the runtime maintainers
88
before they are merged into the `main` branch of the [runtime repository].
99

10+
## Setting up your Git environment
11+
12+
When using a machine or account for the first time, set your local [git
13+
identity] including your name and email address for your commits.
14+
1015
## Setting up your local repository
1116

1217
Using the following steps, you will create a local repository that references
@@ -155,6 +160,7 @@ ability to format a specific commit or only staged files.
155160
[clang-format]: https://clang.llvm.org/docs/ClangFormat.html
156161
[create a forked repository]: https://docs.github.com/en/get-started/quickstart/fork-a-repo#forking-a-repository
157162
[fork and pull model]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/getting-started/about-collaborative-development-models#fork-and-pull-model
163+
[git identity]: https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup#_your_identity
158164
[git worktree]: https://git-scm.com/docs/git-worktree
159165
[git-clang-format]: https://github.com/llvm/llvm-project/blob/9e634b35ff51d0eb2b38013111491e88bdbae388/clang/tools/clang-format/git-clang-format
160166
[pull requests]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests

0 commit comments

Comments
 (0)