From c5c01a4ae7b75a000681a2d48034dc825398f795 Mon Sep 17 00:00:00 2001 From: Sergey Bronnikov Date: Wed, 6 Apr 2022 14:38:53 +0300 Subject: [PATCH] github: add template for pull-request description Commit for #153 introduces changelog and to remind contributors about changelog entries this commit adds a template for pull-request description. Learn more about templates on Github in [1]. 1. https://docs.github.com/en/github-ae@latest/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository Follows up #121 --- .github/pull_request_template.md | 9 +++++ CHANGELOG.md | 66 +++++++++++++++++--------------- 2 files changed, 44 insertions(+), 31 deletions(-) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..70638f98a --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,9 @@ +What has been done? Why? What problem is being solved? + +I didn't forget about (remove if it is not applicable): + +- [ ] Tests (see [documentation](https://pkg.go.dev/testing) for a testing package) +- [ ] Changelog (see [documentation](https://keepachangelog.com/en/1.0.0/) for changelog format) +- [ ] Documentation (see [documentation](https://go.dev/blog/godoc) for documentation style guide) + +Related issues: diff --git a/CHANGELOG.md b/CHANGELOG.md index 52f519038..5dd04eacc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -35,12 +35,12 @@ First release. ### Fixed -- Fix Upsert() for ConnectionMulti infinite recursive call -- Fixed index out of range panic on dial() to short address -- Fix cast in defaultLogger.Report (#49) +- Fix `Upsert()` for `ConnectionMulti` infinite recursive call +- Fixed index out of range panic on `dial()` to short address +- Fix cast in `defaultLogger.Report` (#49) - Fix race condition on extremely small request timeouts (#43) -- Fix notify for Connected transition -- Fix reconnection logic and add Opts.SkipSchema() +- Fix notify for `Connected` transition +- Fix reconnection logic and add `Opts.SkipSchema()` - Fix future sending - Fix panic on disconnect + timeout - Fix block on msgpack error @@ -61,38 +61,38 @@ First release. - Report user mismatch error immediately - Set limit timeout by 0.9 of connection to queue request timeout - Update fields could be negative -- Require RLimitAction to be specified if RateLimit is specified +- Require `RLimitAction` to be specified if `RateLimit` is specified - Use newer typed msgpack interface - Do not start timeouts goroutine if no timeout specified - Clear buffers on connection close -- Update BenchmarkClientParallelMassive +- Update `BenchmarkClientParallelMassive` - Remove array requirements for keys and opts -- Do not allocate Response inplace +- Do not allocate `Response` inplace - Respect timeout on request sending -- Use AfterFunc(fut.timeouted) instead of time.NewTimer() -- Use _vspace/_vindex for introspection -- Method Tuples() always returns table for response +- Use `AfterFunc(fut.timeouted)` instead of `time.NewTimer()` +- Use `_vspace`/`_vindex` for introspection +- Method `Tuples()` always returns table for response ### Removed -- Remove UpsertTyped() method (#23) +- Remove `UpsertTyped()` method (#23) ### Added -- Add Future.WaitChan() and Future.Err() (#86) +- Add `Future.WaitChan()` and `Future.Err()` (#86) - Get node list from nodes (#81) - Add method deleteConnectionFromPool() - Add multiconnections support -- Add Addr() for the connection (#64) -- Add Delete() method for the queue +- Add `Addr()` for the connection (#64) +- Add `Delete()` method for the queue - Implemented typed taking from queue (#55) -- Add OverrideSchema() method for the connection +- Add `OverrideSchema()` method for the connection - Add default case to default logger - Add license (BSD-2 clause as for Tarantool) -- Add GetTyped() method for the connection (#40) -- Add ConfiguredTimeout() for the connection, change queue interface +- Add `GetTyped()` method for the connection (#40) +- Add `ConfiguredTimeout()` for the connection, change queue interface - Add example for queue -- Add GetQueue() method for the queue +- Add `GetQueue()` method for the queue - Add queue support - Add support of Unix socket address - Add check for prefix "tcp:" @@ -100,26 +100,30 @@ First release. - Add note about magic way to pack tuples - Add notification about connection state change - Add workaround for tarantool/tarantool#2060 (#32) -- Add ConnectedNow() method for the connection -- Add IO deadline and use net.Conn.Set(Read|Write)Deadline +- Add `ConnectedNow()` method for the connection +- Add IO deadline and use `net.Conn.Set(Read|Write)Deadline` - Add a couple of benchmarks - Add timeout on connection attempt -- Add RLimitAction option -- Add Call17() for the connection to make a call compatible with Tarantool 1.7 -- Add ClientParallelMassive benchmark -- Add runtime.Gosched for decreasing writer.flush count -- Add Eval, EvalTyped, SelectTyped, InsertTyped, ReplaceTyped, DeleteRequest, UpdateTyped, UpsertTyped methods -- Add UpdateTyped method -- Add CallTyped method -- Add possibility to pass Space and Index objects into Select etc. +- Add `RLimitAction` option +- Add `Call17()` for the connection to make a call compatible with Tarantool 1.7 +- Add `ClientParallelMassive` benchmark +- Add `runtime.Gosched` for decreasing `writer.flush` count +- Add `Eval, `EvalTyped`, `SelectTyped`, `InsertTyped`, `ReplaceTyped`, `DeleteRequest`, `UpdateTyped`, `UpsertTyped` methods +- Add `UpdateTyped` method +- Add `CallTyped` method +- Add possibility to pass `Space` and `Index` objects into `Select` etc. - Add custom MsgPack pack/unpack functions - Add support Tarantool 1.6.8 schema format - Add support Tarantool 1.6.5 schema format - Add schema loading -- Add LocalAddr and RemoteAddr methods for the connection +- Add `LocalAddr` and `RemoteAddr` methods for the connection - Add Upsert method for the connection -- Add Eval() and EvalAsync() methods for the connection +- Add `Eval()` and `EvalAsync()` methods for the connection - Add Tarantool error codes - Add auth support - Add auth during reconnect - Add auth request + +## [alpha] - 2015-01-16 + +Alpha release. See added changes in Git.