Skip to content
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

Improve the MVD tutorial: Textual and programmatic fixes/additions #405

Closed
wants to merge 11 commits into from

Conversation

JohannesLipp
Copy link

What this PR changes/adds

  1. This PR modifies text passages and code snippets in the README.md.
  2. It also adds <shortenClasspath name="ARGS_FILE" /> to all six run configurations.

Why it does that

  1. README: Improve readability and flow, fix possible errors.
  2. Run configurations: Avoid "Command line is too long" error (esp. on Windows).

@paullatzelsperger
Copy link
Member

paullatzelsperger commented Jan 10, 2025

@JohannesLipp please do NOT open unsolicited PRs without first opening an issue/discussion. We have extensive contribution guidelines about that.
No matter how good or useful your PR might appear, there can always be aspects or historic reasons that you might not think of.

For example:

  • your PR title violates our rules (conventional commits)
  • Windows is not a supported platform, nor is PowerShell. That is on purpose.

While you might think "why? I've only made it better by contributing!", the reality is that once we even so much as mention Windows/PS in the docs, people start to have a certain expectations, and we as the maintainers are stuck with supporting that. And we do not want that.

Subtracting any Windows-related aspects, this PR does not add any value IMO, so I think it should be closed.

@paullatzelsperger paullatzelsperger self-requested a review January 10, 2025 12:55
@JohannesLipp
Copy link
Author

Understood, thanks for the info! Closing this PR now.

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.

2 participants