Skip to content

Add WixToolset (and Bash for Windows recommendation) to Windows setup #13567

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from

Conversation

espertus
Copy link
Contributor

Closes JabRef/user-documentation#578
Related to JabRef/user-documentation#579

  • Adds WixToolset to Windows requirements.
  • Recommends Bash for Windows.

I recommend Git for Windows because (1) it is installed with Git Bash and (2) it is commonly used by Windows developers to have a linux-like environment. This generally eliminates the need for separate Windows build instructions. I realize this is kind of pushy so would be happy to remove it from this PR and/or create an issue.

Steps to test

n/a

Mandatory checks

  • I own the copyright of the code submitted and I license it under the MIT license
  • [/] Change in CHANGELOG.md described in a way that is understandable for the average user (if change is visible to the user)
  • [/] Tests created for changes (if applicable)
  • Manually tested changed features in running JabRef (always required)
  • [/] Screenshots added in PR description (if change is visible to the user)
  • Checked developer's documentation: Is the information available and up to date? If not, I outlined it in this pull request.
  • Checked documentation: Is the information available and up to date? If not, I created an issue at https://github.com/JabRef/user-documentation/issues or, even better, I submitted a pull request to the documentation repository.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That was sloppy of me. I will undo and be more careful in the future.

@jabref-machine
Copy link
Collaborator

You committed your code on the main brach of your fork. This is a bad practice. The right way is to branch out from main, work on your patch/feature in that new branch, and then get that branch merged via the pull request (see GitHub flow).

For this pull request, this is OK. For subsequent pull requests, please start with a different branch with a proper branch name. See CONTRIBUTING.md for more details.

@espertus
Copy link
Contributor Author

It's taking me a few attempts to fix the submodules issue. Please don't rereview. I apologize.

@jabref-machine
Copy link
Collaborator

Your pull request modified git submodules.

Please follow our FAQ on submodules to fix.

@jabref-machine
Copy link
Collaborator

Hey, we noticed that you force-pushed your changes. Force pushing is a bad practice when working together on a project (mainly because it is not supported well by GitHub itself). Commits are lost and comments on commits lose their context, thus making it harder to review changes. At the end, all commits will be squashed anyway before being merged into the main branch.

In future, please avoid that. For now, you can continue working.

@espertus espertus mentioned this pull request Jul 21, 2025
4 tasks
@espertus
Copy link
Contributor Author

I replaced this PR with #13568

Sorry for the extra work.

@espertus espertus closed this Jul 21, 2025
Copy link

trag-bot bot commented Jul 21, 2025

@trag-bot didn't find any issues in the code! ✅✨

1 similar comment
Copy link

trag-bot bot commented Jul 21, 2025

@trag-bot didn't find any issues in the code! ✅✨

@espertus
Copy link
Contributor Author

I read more of your guide and see that I shouldn't have created a new PR (which I have now closed) and created another. I have reopened this and will fix it here. Sorry for the bad technique.

@koppor
Copy link
Member

koppor commented Jul 22, 2025

I read more of your guide and see that I shouldn't have created a new PR (which I have now closed) and created another. I have reopened this and will fix it here. Sorry for the bad technique.

No worries 😅. All projects treat things differently 😅. Lookinbg forward!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Incorrect instructions for building from source
4 participants