From e21455f43256aec66827edede6fbb054b1160234 Mon Sep 17 00:00:00 2001 From: Dimitri Date: Sat, 6 Oct 2018 04:09:32 -0400 Subject: [PATCH] Update readme (#77) * added contributing guidelines * updated readme * updated contributing --- CONTRIBUTING.md | 21 +++++++++++++++++++++ README.md | 10 ++++++++-- 2 files changed, 29 insertions(+), 2 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..781f142 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,21 @@ +# Contributing + +When contributing to this repository, please first discuss the change you wish to make via issue or PR. + +## Things to Avoid + +1. Please do not add external dependencies or libraries without discussing them first. +2. The goal of this program is keep the program as lightweight as possible. Try to avoid things that might add uneeded bloat. +3. Do not manually increase the version number, or touch the build scripts unless it is related to the issue. +4. Do not make machine specific changes to solutions or projects. The project should be able to build on any machine with the files provided. +5. Do not use a build system other than MSBUILD. +6. Code Style is not strict, but try to follow what is already in the project. + +## Pull Request Process + +1. Coordinate work being done via issues or PR before work is done. +2. All work must be done on the develop branch or a branch checked out from develop. +3. Update the [CHANGELOG](CHANGELOG.md) with details of changes made. +4. If tests can be added, consider adding them. +5. All builds must actually build, pass pre-scripts, and all tests before being merged. + diff --git a/README.md b/README.md index 798f0c9..8f035c9 100644 --- a/README.md +++ b/README.md @@ -10,9 +10,13 @@ Lightweight program that locks cursor in selected window, designed with performa - Keeps cursor in a windowed game to prevent clicking outside - Will stay active while the window is focused - Keeps cursor in a fullscreen game while using a multi-monitor setup -- Converts any window into a borderless fullscreen window (when set in settings) +- Converts any window into a borderless and/or fullscreen window (when set in settings) -### EXAMPLE +#### Contributing +---------------------- +Contributions are always welcome, but please check [Contributing](CONTRIBUTING.md) guidelines before making a pull request. + +#### EXAMPLE --------------- ![](res/displayLock-preview.png) @@ -21,3 +25,5 @@ Lightweight program that locks cursor in selected window, designed with performa ![](res/example.gif) # ![Download](https://github.com/idietmoran/Display-Lock/releases/) + +[Beta builds can be found from appveyor artifacts](https://ci.appveyor.com/project/idietmoran/display-lock/history)