diff options
author | Matan Bareket | 2018-11-16 09:51:01 -0500 |
---|---|---|
committer | Matan Bareket | 2018-11-16 09:51:01 -0500 |
commit | e2e1ec27781f4b1c8683d86cbaa9730f300ac532 (patch) | |
tree | b9ded5125800b58809d0ed7c88c0c8db15535255 | |
parent | 8c6f9e5116dc6f46e166d8a32f9a9b905ea8634c (diff) | |
download | scummvm-rg350-e2e1ec27781f4b1c8683d86cbaa9730f300ac532.tar.gz scummvm-rg350-e2e1ec27781f4b1c8683d86cbaa9730f300ac532.tar.bz2 scummvm-rg350-e2e1ec27781f4b1c8683d86cbaa9730f300ac532.zip |
GITHUB: Add Pull Request template
-rw-r--r-- | .github/pull_request_template.md | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000000..c0de3d28c2 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,30 @@ + +Thank you for contributing to ScummVM. Please read the following carefully before submitting your Pull Request. + +Make sure your individual commits follow the guidelines found in the ScummVM Wiki: https://wiki.scummvm.org/index.php?title=Commit_Guidelines. If they're not please edit them before submitting the Pull Request. + +Commits and Pull Requests should use the following template: + +``` +SUBSYSTEM: Short (50 chars or less) summary of changes + +More detailed explanatory text, if necessary. Wrap it to about 72 +characters or so. In some contexts, the first line is treated as the +subject of an email and the rest of the text as the body. The blank +line separating the summary from the body is critical (unless you omit +the body entirely); tools like rebase can get confused if you run the +two together. + +Write your commit message in the present tense: "Fix bug" and not "Fixed +bug." This convention matches up with commit messages generated by +commands like git merge and git revert. + +Further paragraphs come after blank lines. + +- Bullet points are okay, too + +- Typically a hyphen or asterisk is used for the bullet, preceded by a + single space, with blank lines in between, but conventions vary here + +- Use a hanging indent +``` |