Skip to content

Commit c5c01a4

Browse files
committed
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
1 parent f208dca commit c5c01a4

File tree

2 files changed

+44
-31
lines changed

2 files changed

+44
-31
lines changed

.github/pull_request_template.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
What has been done? Why? What problem is being solved?
2+
3+
I didn't forget about (remove if it is not applicable):
4+
5+
- [ ] Tests (see [documentation](https://pkg.go.dev/testing) for a testing package)
6+
- [ ] Changelog (see [documentation](https://keepachangelog.com/en/1.0.0/) for changelog format)
7+
- [ ] Documentation (see [documentation](https://go.dev/blog/godoc) for documentation style guide)
8+
9+
Related issues:

CHANGELOG.md

Lines changed: 35 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -35,12 +35,12 @@ First release.
3535

3636
### Fixed
3737

38-
- Fix Upsert() for ConnectionMulti infinite recursive call
39-
- Fixed index out of range panic on dial() to short address
40-
- Fix cast in defaultLogger.Report (#49)
38+
- Fix `Upsert()` for `ConnectionMulti` infinite recursive call
39+
- Fixed index out of range panic on `dial()` to short address
40+
- Fix cast in `defaultLogger.Report` (#49)
4141
- Fix race condition on extremely small request timeouts (#43)
42-
- Fix notify for Connected transition
43-
- Fix reconnection logic and add Opts.SkipSchema()
42+
- Fix notify for `Connected` transition
43+
- Fix reconnection logic and add `Opts.SkipSchema()`
4444
- Fix future sending
4545
- Fix panic on disconnect + timeout
4646
- Fix block on msgpack error
@@ -61,65 +61,69 @@ First release.
6161
- Report user mismatch error immediately
6262
- Set limit timeout by 0.9 of connection to queue request timeout
6363
- Update fields could be negative
64-
- Require RLimitAction to be specified if RateLimit is specified
64+
- Require `RLimitAction` to be specified if `RateLimit` is specified
6565
- Use newer typed msgpack interface
6666
- Do not start timeouts goroutine if no timeout specified
6767
- Clear buffers on connection close
68-
- Update BenchmarkClientParallelMassive
68+
- Update `BenchmarkClientParallelMassive`
6969
- Remove array requirements for keys and opts
70-
- Do not allocate Response inplace
70+
- Do not allocate `Response` inplace
7171
- Respect timeout on request sending
72-
- Use AfterFunc(fut.timeouted) instead of time.NewTimer()
73-
- Use _vspace/_vindex for introspection
74-
- Method Tuples() always returns table for response
72+
- Use `AfterFunc(fut.timeouted)` instead of `time.NewTimer()`
73+
- Use `_vspace`/`_vindex` for introspection
74+
- Method `Tuples()` always returns table for response
7575

7676
### Removed
7777

78-
- Remove UpsertTyped() method (#23)
78+
- Remove `UpsertTyped()` method (#23)
7979

8080
### Added
8181

82-
- Add Future.WaitChan() and Future.Err() (#86)
82+
- Add `Future.WaitChan()` and `Future.Err()` (#86)
8383
- Get node list from nodes (#81)
8484
- Add method deleteConnectionFromPool()
8585
- Add multiconnections support
86-
- Add Addr() for the connection (#64)
87-
- Add Delete() method for the queue
86+
- Add `Addr()` for the connection (#64)
87+
- Add `Delete()` method for the queue
8888
- Implemented typed taking from queue (#55)
89-
- Add OverrideSchema() method for the connection
89+
- Add `OverrideSchema()` method for the connection
9090
- Add default case to default logger
9191
- Add license (BSD-2 clause as for Tarantool)
92-
- Add GetTyped() method for the connection (#40)
93-
- Add ConfiguredTimeout() for the connection, change queue interface
92+
- Add `GetTyped()` method for the connection (#40)
93+
- Add `ConfiguredTimeout()` for the connection, change queue interface
9494
- Add example for queue
95-
- Add GetQueue() method for the queue
95+
- Add `GetQueue()` method for the queue
9696
- Add queue support
9797
- Add support of Unix socket address
9898
- Add check for prefix "tcp:"
9999
- Add the ability to work with the Tarantool via Unix socket
100100
- Add note about magic way to pack tuples
101101
- Add notification about connection state change
102102
- Add workaround for tarantool/tarantool#2060 (#32)
103-
- Add ConnectedNow() method for the connection
104-
- Add IO deadline and use net.Conn.Set(Read|Write)Deadline
103+
- Add `ConnectedNow()` method for the connection
104+
- Add IO deadline and use `net.Conn.Set(Read|Write)Deadline`
105105
- Add a couple of benchmarks
106106
- Add timeout on connection attempt
107-
- Add RLimitAction option
108-
- Add Call17() for the connection to make a call compatible with Tarantool 1.7
109-
- Add ClientParallelMassive benchmark
110-
- Add runtime.Gosched for decreasing writer.flush count
111-
- Add Eval, EvalTyped, SelectTyped, InsertTyped, ReplaceTyped, DeleteRequest, UpdateTyped, UpsertTyped methods
112-
- Add UpdateTyped method
113-
- Add CallTyped method
114-
- Add possibility to pass Space and Index objects into Select etc.
107+
- Add `RLimitAction` option
108+
- Add `Call17()` for the connection to make a call compatible with Tarantool 1.7
109+
- Add `ClientParallelMassive` benchmark
110+
- Add `runtime.Gosched` for decreasing `writer.flush` count
111+
- Add `Eval, `EvalTyped`, `SelectTyped`, `InsertTyped`, `ReplaceTyped`, `DeleteRequest`, `UpdateTyped`, `UpsertTyped` methods
112+
- Add `UpdateTyped` method
113+
- Add `CallTyped` method
114+
- Add possibility to pass `Space` and `Index` objects into `Select` etc.
115115
- Add custom MsgPack pack/unpack functions
116116
- Add support Tarantool 1.6.8 schema format
117117
- Add support Tarantool 1.6.5 schema format
118118
- Add schema loading
119-
- Add LocalAddr and RemoteAddr methods for the connection
119+
- Add `LocalAddr` and `RemoteAddr` methods for the connection
120120
- Add Upsert method for the connection
121-
- Add Eval() and EvalAsync() methods for the connection
121+
- Add `Eval()` and `EvalAsync()` methods for the connection
122122
- Add Tarantool error codes
123123
- Add auth support
124124
- Add auth during reconnect
125125
- Add auth request
126+
127+
## [alpha] - 2015-01-16
128+
129+
Alpha release. See added changes in Git.

0 commit comments

Comments
 (0)