diff --git a/CHANGELOG.md b/CHANGELOG.md index d181a5a0..210848b4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -12,7 +12,7 @@ - IPV6 support for SRV discovery #222 ### Added - - Multistage docker build with default base image 'scratch' + - Multistage docker build - Build as snap package - Latest letsencrypt changes @@ -100,12 +100,12 @@ This release brings several new features and various fixes and improvements. - Propagating sni backend value in scheduler after discovery ### Changed -- Optimizing Docker image (now FROM stratch) +- Optimizing Docker image (now FROM scratch) ## [0.4.0] - 2017-04-07 -This release brings many new features and improvemets, as well as bugfixes. +This release brings many new features and improvements, as well as bugfixes. Major things are UDP support, TLS termination, TLS proxy, SNI-aware balancing. ### New Features @@ -129,7 +129,7 @@ Major things are UDP support, TLS termination, TLS proxy, SNI-aware balancing. ## [0.3.0] - 2016-08-18 -This release brings several new features and improvemets, as well as bugfixes. Major things are +This release brings several new features and improvements, as well as bugfixes. Major things are integrations with Consul, more flexible command-line options and Access control module. ### New Features diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ae945f9c..930cbe42 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,7 +6,7 @@ You can [submit an issue](https://github.com/yyyar/gobetween/issues/new). Please as you can, so that we could either help you to fix your setup, or reproduce the issue on our side. This includes config of gobetween, logs, expected behavior and actual behavior, steps to reproduce. -Please make sure you've cleaned the data you provide us from sencitive information such as public ips, user names, emails, logins, +Please make sure you've cleaned the data you provide us from sensitive information such as public ips, user names, emails, logins, security tokens and other information that you don't want to make public. ## Submitting changes @@ -18,10 +18,10 @@ of what you've done. Please make sure all your commits are atomic (one feature p working on it, or the change you propose does not fit the gobetween ideology. * In case if you have intermediate commits, such as "WIP - work in progress" or sequence of commits that add some files/code and then removes it, please [squash](https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History) them prior to pull request - * Please make sure git commits are descriptve + * Please make sure git commits are descriptive * Please change just a required minimum of code in order to implement your feature or fix a bug. Pull requests that have a lot of not related changes, are hard to review and hard to merge due to possible conflicts with other branches: - * Don't rename existing variables if it's not requred for your change + * Don't rename existing variables if it's not required for your change * Don't add or remove empty strings * Don't autoformat files according to your IDE settings, leave original formatting in places that you don't explicitly change * Write go-doc style comments on functions you add @@ -31,7 +31,7 @@ of what you've done. Please make sure all your commits are atomic (one feature p ## Coding conventions -Please read the code and you'll get the essence of it. Following coding conventions is an attemot to make a short but not +Please read the code and you'll get the essence of it. Following coding conventions is an attempt to make a short but not complete extract: * Simple code is better than smart tricky code diff --git a/README.md b/README.md index d6d432fd..16603369 100644 --- a/README.md +++ b/README.md @@ -34,9 +34,9 @@ * **Stats & Metrics** - for servers and backends including rx/tx, status, active connections & etc. * [Discovery](https://github.com/yyyar/gobetween/wiki/Discovery) - * **Static** - hardcode backends list in config file + * **Static** - hardcode backends list in the config file * **Docker** - query backends from Docker / Swarm API filtered by label - * **Exec** - execute arbitrary program and get backends from its stdout + * **Exec** - execute an arbitrary program and get backends from its stdout * **JSON** - query arbitrary http url and pick backends from response json (of any structure) * **Plaintext** - query arbitrary http and parse backends from response text with customized regexp * **SRV** - query DNS server and get backends from SRV records @@ -46,7 +46,7 @@ * [Healthchecks](https://github.com/yyyar/gobetween/wiki/Healthchecks) * **Ping** - simple TCP ping healthcheck * **Exec** - execute arbitrary program passing host & port as options, and read healthcheck status from the stdout - * **Probe** - send specific bytes to backend (udp, tcp or tls) and expect correct answer (bytes or regexp) + * **Probe** - send specific bytes to backend (udp, tcp or tls) and expect a correct answer (bytes or regexp) * [Balancing Strategies](https://github.com/yyyar/gobetween/wiki/Balancing) (with [SNI](https://github.com/yyyar/gobetween/wiki/Server-Name-Indication) support) * **Weight** - select backend from pool based relative weights of backends