Skip to content

Commit

Permalink
Pull request: all: add depracation section to CHANGELOG.md, imp HACKI…
Browse files Browse the repository at this point in the history
…NG.md

Merge in DNS/adguard-home from doc-deprecated to master

Squashed commit of the following:

commit c189404
Merge: 108097c 1191a9a
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date:   Fri Dec 25 13:40:11 2020 +0300

    Merge branch 'master' into doc-deprecated

commit 108097c
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date:   Fri Dec 25 13:05:03 2020 +0300

    all: imp markup and wording

commit 05a630d
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date:   Thu Dec 24 20:57:43 2020 +0300

    all: add depracation section to CHANGELOG.md, imp HACKING.md
  • Loading branch information
ainar-g committed Dec 25, 2020
1 parent 1191a9a commit 955b735
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 1 deletion.
7 changes: 7 additions & 0 deletions CHANGELOG.md
Expand Up @@ -56,6 +56,13 @@ and this project adheres to
[#2391]: https://github.com/AdguardTeam/AdGuardHome/issues/2391
[#2394]: https://github.com/AdguardTeam/AdGuardHome/issues/2394

### Deprecated

- _Go_ 1.14 support. v0.106.0 will require at least _Go_ 1.15 to build.
- The `darwin/386` port. It will be removed in v0.106.0.
- The `"rule"` and `"filter_id"` fields in `GET /filtering/check_host` and
`GET /querylog` responses. They will be removed in v0.106.0 ([#2102]).

### Fixed

- Inability to set DNS cache TTL limits ([#2459]).
Expand Down
15 changes: 14 additions & 1 deletion HACKING.md
Expand Up @@ -70,6 +70,14 @@ The rules are mostly sorted in the alphabetical order.
func TestType_Method_suffix(t *testing.T) { /**/ }
```

* Name parameters in interface definitions:

```go
type Frobulator interface {
Frobulate(f Foo, b Bar) (r Result, err error)
}
```

* Name the deferred errors (e.g. when closing something) `cerr`.

* No shadowing, since it can often lead to subtle bugs, especially with
Expand Down Expand Up @@ -172,10 +180,15 @@ The rules are mostly sorted in the alphabetical order.
* Put utility flags in the ASCII order and **don't** group them together. For
example, `ls -1 -A -q`.

* `snake_case`, not `camelCase`.
* `snake_case`, not `camelCase` for variables. `kebab-case` for filenames.

* UPPERCASE names for external exported variables, lowercase for local,
unexported ones.

* Use `set -e -f -u` and also `set -x` in verbose mode.

* Use `readonly` liberally.

* Use the `"$var"` form instead of the `$var` form, unless word splitting is
required.

Expand Down

0 comments on commit 955b735

Please sign in to comment.