aboutsummaryrefslogtreecommitdiff
path: root/docs/modding-and-development
diff options
context:
space:
mode:
authorGeckoEidechse <gecko.eidechse+git@pm.me>2022-06-16 19:52:35 +0200
committerGeckoEidechse <gecko.eidechse+git@pm.me>2022-06-16 19:52:35 +0200
commit0d9b611f22634eef6b3cd7d34f193d5372a3513f (patch)
tree9727876df208c2a4ed4f141eeecf1822595e5485 /docs/modding-and-development
parentcc5cb34a2d1b4b370cb1b81c47d2255f5679306a (diff)
downloadNorthstarWiki-0d9b611f22634eef6b3cd7d34f193d5372a3513f.tar.gz
NorthstarWiki-0d9b611f22634eef6b3cd7d34f193d5372a3513f.zip
Add "tips and tricks" section
Diffstat (limited to 'docs/modding-and-development')
-rw-r--r--docs/modding-and-development/development/contributing-code-to-northstar.md15
1 files changed, 14 insertions, 1 deletions
diff --git a/docs/modding-and-development/development/contributing-code-to-northstar.md b/docs/modding-and-development/development/contributing-code-to-northstar.md
index d7399ca..8633e83 100644
--- a/docs/modding-and-development/development/contributing-code-to-northstar.md
+++ b/docs/modding-and-development/development/contributing-code-to-northstar.md
@@ -5,7 +5,7 @@ description: Useful information when contributing to Northstar
# Contributing code to Northstar
{% hint style="info" %}
-TODO
+WIP
{% endhint %}
## Guidelines
@@ -17,3 +17,16 @@ For a pull request to be merged, it has to be reviewed first. In order to make t
- Please describe the changes you made. The easier it is to understand what you changed, the higher the chances of your PR being merged (in a timely manner).
- If you made multiple independent changes, please make a new PR for each one. This prevents cases where your PR is being blocked from merging by a bug one of the changes you made.
+## Tips and tricks
+
+An example of a well-formatted PR description:
+
+{% embed url="https://github.com/R2Northstar/NorthstarMods/pull/392" %}
+
+To get the cropped GIFs of a screenrecording:
+
+1. Use your screenrecording tool of choice (OBS/ShadowPlay/...) to record the clip
+2. Cut it down to just the moment you want to show using [Avidemux](http://www.avidemux.org/), [VLC](https://www.videolan.org/vlc/), etc.
+3. Use a site like [https://ezgif.com/video-to-gif](https://ezgif.com/video-to-gif) for cropping and turning it into a GIF \
+ (The linked site has not been vetted, use at own risk)
+4. Upload GIF to GitHub pull request description by just pasting it at the appropriate location.