From 7897db0beaad96f9ed4ceef6726d4951273b5cb7 Mon Sep 17 00:00:00 2001 From: poikilos <7557867+poikilos@users.noreply.github.com> Date: Sat, 30 Mar 2019 21:50:38 -0400 Subject: [PATCH] improve pull request explanation --- webapp/views/pages/getting-started.ejs | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/webapp/views/pages/getting-started.ejs b/webapp/views/pages/getting-started.ejs index 41fb8e4..26245a6 100644 --- a/webapp/views/pages/getting-started.ejs +++ b/webapp/views/pages/getting-started.ejs @@ -273,7 +273,7 @@ You can find the MIT License online and paste it into Notepad or Geany. Be sure to fill in your name and the year you created the mod. Having a license will make sure others feel safe using your mod and redistributing it if -that's what you want.

+that's what you want.

API means application programming interface. It is just the set of classes and/or functions you use to change the behavior of an existing @@ -312,10 +312,10 @@ files in a mod like that may help.

A public license allows you to change and rerelease the mod, in addition to just being "open source." Many mods are on GitHub, GitLab, or notabug.org to allow easy -forking. Forking is when someone other than the original author +forking. Forking is when someone other than the project owner makes improvements or fixes (often forking implies keeping it separate -and not having your changes pulled in to the author's version). If the -changes +and not having your changes pulled in to the project owner's version). +If the changes are applicable to everyone, you would usually fork it by clicking "fork" which allows you to download your own copy of the mod with "GitHub Desktop" for GitHub on Windows or a public licensed program like "Git @@ -325,7 +325,11 @@ GitHub Desktop), name the commit, click commit, then click push. Then you can go back to the repository online where you got the mod and click "pull request" comparing across forks to the "head" from your repository, allowing the owner to "accept" the request or comment on -changes you need to make or regretfully decline. If the owner declines, +changes you need to make or regretfully decline. Usually pull requests +are preceeded by discussion, often at an issue on the issue tracker. +Unless you are fixing something, you likely will have to present +something the project owner already wants or is trivial but helpful. +If the owner declines, you can always keep your repository and use and distribute your version of the mod if the license allows that. In some cases, you can instead just make a mod that overrides an existing mod--that would require