From a1ea84b28669f679a2e914151bea09129ea67384 Mon Sep 17 00:00:00 2001 From: tt2468 Date: Thu, 14 May 2020 04:46:12 -0700 Subject: [PATCH] Docs: Its finally complaining less --- .github/pull_request_template.md | 10 +++++----- CONTRIBUTING.md | 16 ++++++++-------- 2 files changed, 13 insertions(+), 13 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 36c332c5..d6fe377d 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -27,9 +27,9 @@ Tested OS(s): ### Checklist: -- [ ] I have read the [**contributing** document](https://github.com/Palakis/obs-websocket/blob/4.x-current/CONTRIBUTING.md). -- [ ] My code is not on the master branch. -- [ ] The code has been tested. -- [ ] All commit messages are properly formatted and commits squashed where appropriate. -- [ ] I have included updates to all appropriate documentation. +- [ ] I have read the [**contributing** document](https://github.com/Palakis/obs-websocket/blob/4.x-current/CONTRIBUTING.md). +- [ ] My code is not on the master branch. +- [ ] The code has been tested. +- [ ] All commit messages are properly formatted and commits squashed where appropriate. +- [ ] I have included updates to all appropriate documentation. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 60654035..1931c0c6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -46,15 +46,15 @@ return req->SendOKResponse(); ### Commit Guidelines - Commits follow the 50/72 standard: - - 50 characters max for the commit title (excluding scope name) - - One empty line after the title - - Description wrapped to 72 columns max width per line. + - 50 characters max for the commit title (excluding scope name) + - One empty line after the title + - Description wrapped to 72 columns max width per line. - Commit titles: - - Use present tense - - Prefix the title with a "scope" name - - e.g: "CI: fix wrong behaviour when packaging for OS X" - - Typical scopes: CI, General, Requests, Events, Server + - Use present tense + - Prefix the title with a "scope" name + - e.g: "CI: fix wrong behaviour when packaging for OS X" + - Typical scopes: CI, General, Requests, Events, Server **Example commit:** @@ -69,7 +69,7 @@ transitions. ### Pull Requests - Pull Requests must never be based off your fork's main branch (in this case, `4.x-current`). - - Start your work in a newly named branch based on the upstream main one (e.g.: `feature/cool-new-feature`, `bugfix/fix-palakis-mistakes`, ...) + - Start your work in a newly named branch based on the upstream main one (e.g.: `feature/cool-new-feature`, `bugfix/fix-palakis-mistakes`, ...) - Only open a pull request if you are ready to show off your work.