From 59d8808e045541ca75888ed3d886c68f7468f5ae Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Yoann=20Rodi=C3=A8re?= Date: Mon, 18 Sep 2023 15:12:23 +0200 Subject: [PATCH] Update contributor docs for Windows users --- CONTRIBUTING.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b890b24787d..c22e7884906 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -94,11 +94,12 @@ few prerequisite steps: * Make sure you have a [Hibernate JIRA account](https://hibernate.atlassian.net) * Make sure you have a [GitHub account](https://github.com/signup/free) -* [Fork](https://help.github.com/articles/fork-a-repo/) the Hibernate Search [repository](https://github.com/hibernate/hibernate-search). -As discussed in the linked page, this also includes: - * [Setting](https://help.github.com/articles/set-up-git) up your local git install - * Cloning your fork -* Instruct git to ignore certain commits when using `git blame`: +* Make sure you have [set up git locally](https://help.github.com/articles/set-up-git) +* On Windows, run `git config --global core.longpaths true` +so that you are able to clone the Hibernate Search repository +* [Fork](https://help.github.com/articles/fork-a-repo/) the [Hibernate Search repository](https://github.com/hibernate/hibernate-search) +* Instruct git to ignore certain commits when using `git blame`. +From the directory of your local clone, run this: `git config blame.ignoreRevsFile .git-blame-ignore-revs` ### Development environment