diff options
| author | GeckoEidechse <gecko.eidechse+git@pm.me> | 2022-06-16 19:44:10 +0200 |
|---|---|---|
| committer | GeckoEidechse <gecko.eidechse+git@pm.me> | 2022-06-16 19:44:10 +0200 |
| commit | cc5cb34a2d1b4b370cb1b81c47d2255f5679306a (patch) | |
| tree | 7ea5ef2588268808ef870a560f410f384671ccc7 /docs/modding-and-development | |
| parent | 312b67acfa19e07680ace3f925511f6b4fb1f7b3 (diff) | |
| download | NorthstarWiki-cc5cb34a2d1b4b370cb1b81c47d2255f5679306a.tar.gz NorthstarWiki-cc5cb34a2d1b4b370cb1b81c47d2255f5679306a.zip | |
Add guidelines section
Diffstat (limited to 'docs/modding-and-development')
| -rw-r--r-- | docs/modding-and-development/development/contributing-code-to-northstar.md | 9 |
1 files changed, 9 insertions, 0 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 a54dc30..d7399ca 100644 --- a/docs/modding-and-development/development/contributing-code-to-northstar.md +++ b/docs/modding-and-development/development/contributing-code-to-northstar.md @@ -8,3 +8,12 @@ description: Useful information when contributing to Northstar TODO {% endhint %} +## Guidelines + +For a pull request to be merged, it has to be reviewed first. In order to make the review process as smooth as possible and therefore ensuring quick merging of your pull request, keep the following things in mind: + +- If the changes you made can be summarised in a screenshot or screenrecording, make sure to add one to quickly give a reviewer an idea what your pull request is about. +- Please use a sensible title for your pull request. We squash commits when merging and as such your pull request title will be used as the commit message. We can of course edit it before merging but using a sensible title for your PR both makes it easier to understand what it is about and saves us from having to edit the title before merging. +- 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. + |