Merge pull request #412 from DasSkelett/feature/branch-warning

 Show a warning comment for PRs targeting the wrong base branch

Author: HebaruSan

.github/workflows/branch-warning.yml

@@ -0,0 +1,30 @@
+name: Wrong base branch warning
+
+on:
+  # The pull_request_target trigger runs the workflow in the context of the base branch
+  # which has security benefits and is enough for our purposes
+  # https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows#pull_request_target
+  pull_request_target:
+      types: [ opened ]
+
+jobs:
+  branch-warning:
+    # https://docs.github.com/en/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull_request
+    if: (github.event.pull_request_target.base.label == 'KSP-SpaceDock:master'
+          && github.event.pull_request_target.head.label != 'KSP-SpaceDock:beta')
+        || (github.event.pull_request_target.base.label == 'KSP-SpaceDock:beta'
+          && github.event.pull_request_target.head.label != 'KSP-SpaceDock:alpha')
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
+    steps:
+    # https://docs.github.com/en/actions/managing-issues-and-pull-requests/commenting-on-an-issue-when-a-label-is-added
+    - name: Trigger warning comment
+      uses: peter-evans/create-or-update-comment@v1
+      with:
+        issue-number: ${{ github.event.pull_request_target.number }}
+        body: |
+          ⚠️ Warning ⚠️ This pull request is targeting `${{ github.event.pull_request.base.ref }}`.
+          New changes need to go to `alpha` first and will be merged to `beta` and `master` in batches, see [this section in our wiki](https://github.com/KSP-SpaceDock/SpaceDock/wiki/Development-Guide#branching-system).
+
+          You can change the target base of the pull request by clicking "Edit" next to the title and selecting `alpha` in the dropdown to the left.

CONTRIBUTING.md

@@ -1,38 +1,38 @@
-GIT
----
-Cloning
+## Getting started
 
-    git clone https://github.com/KSP-SpaceDock/SpaceDock.git
+Please read the [Development Guide](https://github.com/KSP-SpaceDock/SpaceDock/wiki/Development-Guide).
+If you are interested in the infrastructure and production setup of SpaceDock, see [Infrastructure](https://github.com/KSP-SpaceDock/SpaceDock/wiki/Infrastructure).
 
-Updating
 
-    git fetch --all
-    git merge
+## GIT
 
-Contributing
-First you will need to fork "SpaceDock" on github, and set up your SSH key.
+### Setup
 
-    git remote rm origin
-    git remote add upstream https://github.com/KSP-SpaceDock/SpaceDock.git
-    git remote add origin git@github.com:YOUR_USER_NAME_HERE/SpaceDock.git
-    git fetch --all
-    git push --set-upstream origin master
+1) [Fork the repository on GitHub](https://guides.github.com/activities/forking/)
+2) Clone your fork: `git clone https://github.com/<YourUsername>/SpaceDock.git`
+3) Configure `git pull` to do fast-forward merges only: `git config --global pull.ff=only`
+4) Add the main repo as a remote: `git remote add upstream https://github.com/KSP-SpaceDock/SpaceDock.git`
+5) Get the alpha branch from the main repo: `git checkout -b alpha upstream/alpha`
 
-Make a branch so you don't bork your master.
 
-    git branch bugfix-number
-    git checkout bugfix-number
+### Adding changes
 
-Do your changes here with your favourite text editor or IDE.
+1) First check out `alpha`: `git checkout alpha`
+2) Make sure it is up-to-date: `git pull upstream alpha`
+3) Create a new branch: `git checkout -b fix/<one-to-three-word-summary>`
+   We tend to prefix our branch names with `fix/` for bugfixes and `feature/` for new features
+4) Do your changes here with your favourite text editor or IDE.
+5) Add your changes to the index: `git add <path/to/changed/file> <path/to/another/file>`
+   Make sure you only add changes that you actually want to commit! `git commit -A` might include files you didn't want to.
+   You can review your currently added changes with: `git diff --staged`
+6) Create a commit with the staged changes: `git commit -m "A small message about your commit`
+7) Push the changes to your GitHub fork: `git push --set-upstream origin fix/<one-to-three-word-summary>`
+8) Prepare a pull request on GitHub. If you open your fork on github.com it probably already shows you a button to do this.
+   Enter a detailed summary into the PR body text box.
+   Include your motivation for the feature, a way to reproduce the bug if possible, and other points that might be important or helpful for reviewers.
+   Go through your diff one more time to make sure everything is included, do a "self-review".
 
-    git add -A
-    git commit -a -m "A small message about your commit"
-    git push --set-upstream origin bugfix-number
-
-When you are happy with the code, open a pull request on github. After it is merged you can delete it and merge it in your master
-
-    git checkout master
-    git fetch --all
-    git merge upstream/master
-    git branch -D bugfix-number
-    git push origin :bugfix-number
+There are more extensive guides available at https://guides.github.com/, e.g.
+- https://github.com/git-guides
+- https://guides.github.com/introduction/git-handbook/
+- https://guides.github.com/introduction/flow/

README.md

@@ -4,6 +4,10 @@ Website engine for Kerbal Space Program mods.
 
 https://spacedock.info
 
+## Contributing
+
+Please see [CONTRIBUTING.md](./CONTRIBUTING.md)
+
 ## Installation
 
 This describes a bare-metal setup. For a local development setup using Docker, see https://github.com/KSP-SpaceDock/SpaceDock/wiki/Development-Guide#running-with-docker.