Mirrored_Repos/obs-websocket
1
0
Fork 0
mirror of https://github.com/Palakis/obs-websocket.git synced 2024-08-30 18:12:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

Docs: Its finally complaining less

Browse Source
This commit is contained in:
tt2468 2020-05-14 04:46:12 -07:00
parent baba8790bc
commit a1ea84b286
2 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
.github/pull_request_template.md vendored
View File

@ -27,9 +27,9 @@ Tested OS(s):
### Checklist: ### Checklist:
<!--- Go over all the following points, and put an `x` in all the boxes that apply. --> <!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> <!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
- [ ] I have read the [**contributing** document](https://github.com/Palakis/obs-websocket/blob/4.x-current/CONTRIBUTING.md). - [ ] 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. - [ ] My code is not on the master branch.
- [ ] The code has been tested. - [ ] The code has been tested.
- [ ] All commit messages are properly formatted and commits squashed where appropriate. - [ ] All commit messages are properly formatted and commits squashed where appropriate.
- [ ] I have included updates to all appropriate documentation. - [ ] I have included updates to all appropriate documentation.

16
CONTRIBUTING.md
View File

@ -46,15 +46,15 @@ return req->SendOKResponse();
### Commit Guidelines ### Commit Guidelines
- Commits follow the 50/72 standard: - Commits follow the 50/72 standard:
- 50 characters max for the commit title (excluding scope name) - 50 characters max for the commit title (excluding scope name)
- One empty line after the title - One empty line after the title
- Description wrapped to 72 columns max width per line. - Description wrapped to 72 columns max width per line.
- Commit titles: - Commit titles:
- Use present tense - Use present tense
- Prefix the title with a "scope" name - Prefix the title with a "scope" name
- e.g: "CI: fix wrong behaviour when packaging for OS X" - e.g: "CI: fix wrong behaviour when packaging for OS X"
- Typical scopes: CI, General, Requests, Events, Server - Typical scopes: CI, General, Requests, Events, Server
**Example commit:** **Example commit:**
@ -69,7 +69,7 @@ transitions.
### Pull Requests ### Pull Requests
- Pull Requests must never be based off your fork's main branch (in this case, `4.x-current`). - 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. - Only open a pull request if you are ready to show off your work.