Creating developer environment under Windows / Cygwin

[albert-github]

I wanted to contribute to the repository to improve the documentation (seen the problems with e.g. #3654, #4161).
So:

• I forked and cloned the repository,
• I made my changes
• I tested the changes (running appropriate cmake command and nmake Documentation)
• I created a local branch
• I wanted to commit but this gave me the error:

   git -c diff.mnemonicprefix=false -c core.quotepath=false --no-optional-locks commit -q -F C:\Users\User\AppData\Local\Temp\krozvm4o.yud -a
  Your work tree has not been configured for ITK development.
  Paste the following commands into a shell:
  
  ./Utilities/SetupForDevelopment.sh
  
  See https://docs.itk.org/en/latest/contributing/index.html for more details.
  
  
  
  
  Completed with errors, see above.
  

  • next step was to run the mentioned script, but this failed as pixi is not available for my platform.

    This script will automatically download and install Pixi (latest) for you.
    Getting it from this url: https://github.com/prefix-dev/pixi/releases/latest/download/pixi-x86_64-CYGWIN_NT-10.0-19045.tar.gz
      % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                     Dload  Upload   Total   Spent    Left  Speed
      0     0    0     0    0     0      0      0 --:--:-- --:--:-- --:--:--     0
    100     9  100     9    0     0     18      0 --:--:-- --:--:-- --:--:--    18
    main: line 83: [[: %http_code: syntax error: operand expected (error token is "%http_code")
    main: line 83: [[: %http_code: syntax error: operand expected (error token is "%http_code")
    
    gzip: stdin: not in gzip format
    tar: Child returned status 1
    tar: Error is not recoverable: exiting now
    Failed to setup pre-commit.
    

System, a bit hybrid, being Windows (10) with Cygwin and using (Atlassian) sourcetree.

• how can I get it the commits working on Windows / Cygwin

[github-actions]

Thank you for contributing an issue! 🙏

Welcome to the ITK community! 🤗👋☀️

We are glad you are here and appreciate your contribution. Please keep in mind our community participation guidelines. 📜
Also, please check existing open issues and consider discussion on the ITK Discourse. 📖

This is an automatic message. Allow for time for the ITK community to be able to read the issue and comment on it.

[dzenanz]

For plain Windows, start Git Bash, cd to the repo directory, then run ./Utilities/SetupForDevelopment.sh. Cygwin is somewhat exotic, and we don't support it - it may, or may not work.

[albert-github]

Thanks fore the answer and indeed Cygwin is a bit exotic but quite convenient.

It looks like I don't have a git bash, I will have to see further (I could start just bash being the Cygwin bash but this won't help (I think)).
Maybe I should install the windows git distribution (but I don't want to ruin my normal workflow and in the past I've seen quite a few problems with different versions of git around).
I have to think about it ... maybe delivering patches as patch files in issues.

[dzenanz]

Thank you for your contributions Albert. Taking their number over the hast few days into account, it is such a shame you did not have a better contribution experience. Most people who use Cygwin do so because they are used to Unix environment. If you have a Linux machine, you could try contributing to ITK that way, instead of via Cygwin. ITK fully support Linux!