forked from Nordix/eredis
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Bump version and add CONTRIBUTING.md
- Loading branch information
1 parent
adaa51f
commit 4001fe5
Showing
4 changed files
with
37 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,12 @@ | ||
# CHANGELOG | ||
|
||
## v1.4.1 | ||
|
||
June 2021. | ||
|
||
* Restore support for rebar 2. | ||
* Optimize parser. | ||
|
||
## v1.4.0 | ||
|
||
June 2021. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
Contributing to eredis | ||
====================== | ||
|
||
Requirements: Erlang/OTP, rebar3 and make. For tests, also Docker and OpenSSL. | ||
|
||
* `make test` runs the tests using Docker and generates TLS certificates using | ||
OpenSSL. If you can't run it or if some test (e.g. the IPv6 test) fails, it's | ||
fine as long as it passes in the automated builds. | ||
* When docs are affected, run `make edoc` and commit the changed Markdown files | ||
under `doc/`. | ||
* Don't update the version unless agreed with the maintainers. | ||
|
||
Releasing a new version | ||
----------------------- | ||
|
||
Normally done by the maintainers. | ||
|
||
* Update the version in `src/eredis.app.src` and `mix.exs`. | ||
* Update CHANGELOG.md and add what's new since the last version. (Use e.g. `git | ||
log *PREV_VERSION*..HEAD`). | ||
* Check that documentation is generated and commited using `make edoc`. | ||
* Commit the changes, push and check the build. | ||
* Publish to Hex using `make publish` (requires `mix` and a Hex account with | ||
rights to publish this project). (This can be done later.) | ||
* Create an annotated tag on the form vMAJOR.MINOR.PATCH, `git tag -a v0.0.0`. | ||
Write a very short message with the most important changes (one line or a few | ||
bullets). | ||
* Push the tag using `git push --tags`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters