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

make the getting started page far less condescending #116

Merged
merged 4 commits into from
Nov 13, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/commit-preview.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jobs:
name: Generate commit preview
steps:
- name: Checkout
uses: actions/checkout@v3
uses: actions/checkout@v4

- name: Enable Corepack shims
run: corepack enable
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/pr-preview.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ jobs:
name: Generate PR preview
steps:
- name: Checkout
uses: actions/checkout@v3
uses: actions/checkout@v4

- name: Enable Corepack shims
run: corepack enable
Expand All @@ -22,7 +22,7 @@ jobs:
run: pnpm build

- name: Upload HTML artifact
uses: actions/upload-artifact@v2
uses: actions/upload-artifact@v4
with:
name: website-html
path: build
Expand Down
8 changes: 3 additions & 5 deletions wiki/introduction/getting-started/en.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,9 @@ Minecraft modding can get complicated. We aim to provide a resource to help you
fundamental modding concepts. However, there are some things that we can't do and
expect you to learn on your own.

Asking questions properly, whether it is on our forum or on Discord, is an essential
skill to have. Never be afraid to ask questions, we're always willing to help, and we
don't judge.
Never be afraid to ask questions, we're always willing to help, and we don't judge.

When asking questions, try to include the necessary context in your first message, and [do not ask to ask](https://dontasktoask.com/). State your problem, what you have already tried to solve it, and how those attempts failed. Make sure to avoid the [XY problem](https://xyproblem.info/) by not only asking for help for one specific part of a solution to your problem, but also stating the actual problem you are trying to solve. When debugging, include your `latest.log` and when your game crashes, a crash log. Additionally, full access to your source code can be really helpful, ideally uploaded to a website such as GitHub.
When asking questions, try to include the necessary context in your first message. State your problem, what you have already tried to solve it, and how those attempts failed. Giving full context to your problem will help others solve it faster. When debugging, include your `latest.log` and when your game crashes, a crash log. Additionally, full access to your source code can be really helpful, ideally uploaded to a website such as GitHub.

You can ask development related questions in our [Forum](https://forum.quiltmc.org/), as well as in the [mod-dev-help](https://discord.com/channels/817576132726620200/1047429688521396325) forum channel in our [Discord](https://discord.quiltmc.org/)

Expand All @@ -50,7 +48,7 @@ examples of how to do things in open source repositories and sometimes "steal" c
Open source repositories are there for you to learn from and use, don't be afraid of
them!

There are many topics in modding where you quickly will find yourself at a point where there are no tutorials to help. In those cases you'll usually either have to understand the relevant Minecraft code, or look at other mods and see how they got similar things done.
There are many topics in modding where you may quickly find there are many topics in modding lacking relevant tutorials. In those cases you may have to read the relevant Minecraft code, or look at other mods and see how they implemented similar ideas, methods or solutions.
woodiertexas marked this conversation as resolved.
Show resolved Hide resolved
If you want to look into the Minecraft source code, run the `genSourcesWithVineflower` Gradle task in the `fabric` category or open any Minecraft source file and click the download sources button in IntelliJ IDEA.

<!-- TODO: Is this todo fixed?: Levi write your thing about stealing code here -->